C# Class Box.V2.Managers.BoxRetentionPoliciesManager

The class managing the Box API's Retention Policies endpoint. Retention Management is a feature of the Box Governance package, which can be added on to any Business Plus or Enterprise account. To use this feature, you must have the manage retention policies scope enabled for your API key via your application management console.

Inheritance: BoxResourceManager

Show file Open project: box/box-windows-sdk-v2

Public Methods

Method	Description
BoxRetentionPoliciesManager ( IBoxConfig config, IBoxService service, IBoxConverter converter, IAuthRepository auth, string asUser = null, bool suppressNotifications = null ) : Box.V2.Auth
CreateRetentionPolicyAssignmentAsync ( BoxRetentionPolicyAssignmentRequest policyAssignmentRequest, List fields = null ) : Task	Creates a retention policy assignment that associates a retention policy with either a folder or an enterprise
CreateRetentionPolicyAsync ( BoxRetentionPolicyRequest retentionPolicyRequest ) : Task	Used to create a new retention policy.
GetFileVersionRetentionAsync ( string fileVersionRetentionId, List fields = null ) : Task	Used to retrieve information about a file version retention.
GetFileVersionRetentionsAsync ( List fields = null, int limit = 100, string marker = null, bool autoPaginate = false ) : Task>	Retrieves all file version retentions for the given enterprise.
GetRetentionPoliciesAsync ( string policyName = null, string policyType = null, string createdByUserId = null, List fields = null, int limit = 100, string marker = null, bool autoPaginate = false ) : Task>	Retrieves all of the retention policies for the given enterprise.
GetRetentionPolicyAssignmentAsync ( string retentionPolicyAssignmentId, List fields = null ) : Task	Used to retrieve information about a retention policy assignment.
GetRetentionPolicyAssignmentsAsync ( string retentionPolicyId, string type = null, List fields = null, int limit = 100, string marker = null, bool autoPaginate = false ) : Task>	Returns a list of all retention policy assignments associated with a specified retention policy.
GetRetentionPolicyAsync ( string id, List fields = null ) : Task	Used to retrieve information about a retention policy.
UpdateRetentionPolicyAsync ( string id, BoxRetentionPolicyRequest retentionPolicyRequest, List fields = null ) : Task	Used to update a retention policy.

Method Details

BoxRetentionPoliciesManager() public method

public BoxRetentionPoliciesManager ( IBoxConfig config, IBoxService service, IBoxConverter converter, IAuthRepository auth, string asUser = null, bool suppressNotifications = null ) : Box.V2.Auth
config	IBoxConfig
service	IBoxService
converter	IBoxConverter
auth	IAuthRepository
asUser	string
suppressNotifications	bool
return	Box.V2.Auth

CreateRetentionPolicyAssignmentAsync() public method

Creates a retention policy assignment that associates a retention policy with either a folder or an enterprise

public CreateRetentionPolicyAssignmentAsync ( BoxRetentionPolicyAssignmentRequest policyAssignmentRequest, List fields = null ) : Task
policyAssignmentRequest	Box.V2.Models.Request.BoxRetentionPolicyAssignmentRequest
fields	List	Attribute(s) to include in the response.
return	Task

CreateRetentionPolicyAsync() public method

Used to create a new retention policy.

public CreateRetentionPolicyAsync ( BoxRetentionPolicyRequest retentionPolicyRequest ) : Task
retentionPolicyRequest	Box.V2.Models.Request.BoxRetentionPolicyRequest	BoxRetentionPolicyRequest object.
return	Task

GetFileVersionRetentionAsync() public method

Used to retrieve information about a file version retention.

public GetFileVersionRetentionAsync ( string fileVersionRetentionId, List fields = null ) : Task
fileVersionRetentionId	string	ID of the file version retention policy.
fields	List	Attribute(s) to include in the response.
return	Task

GetFileVersionRetentionsAsync() public method

Retrieves all file version retentions for the given enterprise.

public GetFileVersionRetentionsAsync ( List fields = null, int limit = 100, string marker = null, bool autoPaginate = false ) : Task>
fields	List	Attribute(s) to include in the response.
limit	int	Limit result size to this number. Defaults to 100, maximum is 1,000.
marker	string	Take from "next_marker" column of a prior call to get the next page.
autoPaginate	bool	Whether or not to auto-paginate to fetch all items; defaults to false.
return	Task>

GetRetentionPoliciesAsync() public method

Retrieves all of the retention policies for the given enterprise.

public GetRetentionPoliciesAsync ( string policyName = null, string policyType = null, string createdByUserId = null, List fields = null, int limit = 100, string marker = null, bool autoPaginate = false ) : Task>
policyName	string	A name to filter the retention policies by. A trailing partial match search is performed.
policyType	string	A policy type to filter the retention policies by.
createdByUserId	string	A user id to filter the retention policies by.
fields	List	Attribute(s) to include in the response.
limit	int	Limit result size to this number. Defaults to 100, maximum is 1,000.
marker	string	Take from "next_marker" column of a prior call to get the next page.
autoPaginate	bool	Whether or not to auto-paginate to fetch all items; defaults to false.
return	Task>

GetRetentionPolicyAssignmentAsync() public method

Used to retrieve information about a retention policy assignment.

public GetRetentionPolicyAssignmentAsync ( string retentionPolicyAssignmentId, List fields = null ) : Task
retentionPolicyAssignmentId	string	ID of the retention policy assignment.
fields	List	Attribute(s) to include in the response.
return	Task

GetRetentionPolicyAssignmentsAsync() public method

Returns a list of all retention policy assignments associated with a specified retention policy.

public GetRetentionPolicyAssignmentsAsync ( string retentionPolicyId, string type = null, List fields = null, int limit = 100, string marker = null, bool autoPaginate = false ) : Task>
retentionPolicyId	string	ID of the retention policy.
type	string	The type of the retention policy assignment to retrieve. Can either be folder or enterprise.
fields	List	Attribute(s) to include in the response.
limit	int	Limit result size to this number. Defaults to 100, maximum is 1,000.
marker	string	Take from "next_marker" column of a prior call to get the next page.
autoPaginate	bool	Whether or not to auto-paginate to fetch all items; defaults to false.
return	Task>

GetRetentionPolicyAsync() public method

Used to retrieve information about a retention policy.

public GetRetentionPolicyAsync ( string id, List fields = null ) : Task
id	string	ID of the retention policy.
fields	List	Attribute(s) to include in the response.
return	Task

UpdateRetentionPolicyAsync() public method

Used to update a retention policy.

public UpdateRetentionPolicyAsync ( string id, BoxRetentionPolicyRequest retentionPolicyRequest, List fields = null ) : Task
id	string	ID of the retention policy.
retentionPolicyRequest	Box.V2.Models.Request.BoxRetentionPolicyRequest	BoxRetentionPolicyRequest object.
fields	List	Attribute(s) to include in the response.
return	Task