Skip to content

Latest commit

 

History

History
175 lines (112 loc) · 5.75 KB

RetentionPolicyAssignments.md

File metadata and controls

175 lines (112 loc) · 5.75 KB

IRetentionPolicyAssignmentsManager

List retention policy assignments

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

This operation is performed by calling function GetRetentionPolicyAssignments.

See the endpoint docs at API Reference.

await client.RetentionPolicyAssignments.GetRetentionPolicyAssignmentsAsync(retentionPolicyId: retentionPolicy.Id);

Arguments

  • retentionPolicyId string
    • The ID of the retention policy. Example: "982312"
  • queryParams GetRetentionPolicyAssignmentsQueryParams
    • Query parameters of getRetentionPolicyAssignments method
  • headers GetRetentionPolicyAssignmentsHeaders
    • Headers of getRetentionPolicyAssignments method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type RetentionPolicyAssignments.

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

Assign retention policy

Assigns a retention policy to an item.

This operation is performed by calling function CreateRetentionPolicyAssignment.

See the endpoint docs at API Reference.

await client.RetentionPolicyAssignments.CreateRetentionPolicyAssignmentAsync(requestBody: new CreateRetentionPolicyAssignmentRequestBody(policyId: retentionPolicy.Id, assignTo: new CreateRetentionPolicyAssignmentRequestBodyAssignToField(type: CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField.Folder) { Id = folder.Id }));

Arguments

  • requestBody CreateRetentionPolicyAssignmentRequestBody
    • Request body of createRetentionPolicyAssignment method
  • headers CreateRetentionPolicyAssignmentHeaders
    • Headers of createRetentionPolicyAssignment method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type RetentionPolicyAssignment.

Returns a new retention policy assignment object.

Get retention policy assignment

Retrieves a retention policy assignment

This operation is performed by calling function GetRetentionPolicyAssignmentById.

See the endpoint docs at API Reference.

await client.RetentionPolicyAssignments.GetRetentionPolicyAssignmentByIdAsync(retentionPolicyAssignmentId: retentionPolicyAssignment.Id);

Arguments

  • retentionPolicyAssignmentId string
    • The ID of the retention policy assignment. Example: "1233123"
  • queryParams GetRetentionPolicyAssignmentByIdQueryParams
    • Query parameters of getRetentionPolicyAssignmentById method
  • headers GetRetentionPolicyAssignmentByIdHeaders
    • Headers of getRetentionPolicyAssignmentById method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type RetentionPolicyAssignment.

Returns the retention policy assignment object.

Remove retention policy assignment

Removes a retention policy assignment applied to content.

This operation is performed by calling function DeleteRetentionPolicyAssignmentById.

See the endpoint docs at API Reference.

await client.RetentionPolicyAssignments.DeleteRetentionPolicyAssignmentByIdAsync(retentionPolicyAssignmentId: retentionPolicyAssignment.Id);

Arguments

  • retentionPolicyAssignmentId string
    • The ID of the retention policy assignment. Example: "1233123"
  • headers DeleteRetentionPolicyAssignmentByIdHeaders
    • Headers of deleteRetentionPolicyAssignmentById method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type null.

Returns an empty response when the policy assignment is successfully deleted.

Get files under retention

Returns a list of files under retention for a retention policy assignment.

This operation is performed by calling function GetFilesUnderRetentionPolicyAssignment.

See the endpoint docs at API Reference.

await client.RetentionPolicyAssignments.GetFilesUnderRetentionPolicyAssignmentAsync(retentionPolicyAssignmentId: retentionPolicyAssignment.Id);

Arguments

  • retentionPolicyAssignmentId string
    • The ID of the retention policy assignment. Example: "1233123"
  • queryParams GetFilesUnderRetentionPolicyAssignmentQueryParams
    • Query parameters of getFilesUnderRetentionPolicyAssignment method
  • headers GetFilesUnderRetentionPolicyAssignmentHeaders
    • Headers of getFilesUnderRetentionPolicyAssignment method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type FilesUnderRetention.

Returns a list of files under retention that are associated with the specified retention policy assignment.