Skip to content

Latest commit

 

History

History
171 lines (107 loc) · 4.64 KB

LegalHoldPolicies.md

File metadata and controls

171 lines (107 loc) · 4.64 KB

ILegalHoldPoliciesManager

List all legal hold policies

Retrieves a list of legal hold policies that belong to an enterprise.

This operation is performed by calling function GetLegalHoldPolicies.

See the endpoint docs at API Reference.

await client.LegalHoldPolicies.GetLegalHoldPoliciesAsync();

Arguments

  • queryParams GetLegalHoldPoliciesQueryParams
    • Query parameters of getLegalHoldPolicies method
  • headers GetLegalHoldPoliciesHeaders
    • Headers of getLegalHoldPolicies method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type LegalHoldPolicies.

Returns a list of legal hold policies.

Create legal hold policy

Create a new legal hold policy.

This operation is performed by calling function CreateLegalHoldPolicy.

See the endpoint docs at API Reference.

await client.LegalHoldPolicies.CreateLegalHoldPolicyAsync(requestBody: new CreateLegalHoldPolicyRequestBody(policyName: legalHoldPolicyName) { Description = legalHoldDescription, IsOngoing = true });

Arguments

  • requestBody CreateLegalHoldPolicyRequestBody
    • Request body of createLegalHoldPolicy method
  • headers CreateLegalHoldPolicyHeaders
    • Headers of createLegalHoldPolicy method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type LegalHoldPolicy.

Returns a new legal hold policy object.

Get legal hold policy

Retrieve a legal hold policy.

This operation is performed by calling function GetLegalHoldPolicyById.

See the endpoint docs at API Reference.

await client.LegalHoldPolicies.GetLegalHoldPolicyByIdAsync(legalHoldPolicyId: legalHoldPolicyId);

Arguments

  • legalHoldPolicyId string
    • The ID of the legal hold policy Example: "324432"
  • headers GetLegalHoldPolicyByIdHeaders
    • Headers of getLegalHoldPolicyById method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type LegalHoldPolicy.

Returns a legal hold policy object.

Update legal hold policy

Update legal hold policy.

This operation is performed by calling function UpdateLegalHoldPolicyById.

See the endpoint docs at API Reference.

await client.LegalHoldPolicies.UpdateLegalHoldPolicyByIdAsync(legalHoldPolicyId: legalHoldPolicyId, requestBody: new UpdateLegalHoldPolicyByIdRequestBody() { PolicyName = updatedLegalHoldPolicyName });

Arguments

  • legalHoldPolicyId string
    • The ID of the legal hold policy Example: "324432"
  • requestBody UpdateLegalHoldPolicyByIdRequestBody
    • Request body of updateLegalHoldPolicyById method
  • headers UpdateLegalHoldPolicyByIdHeaders
    • Headers of updateLegalHoldPolicyById method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type LegalHoldPolicy.

Returns a new legal hold policy object.

Remove legal hold policy

Delete an existing legal hold policy.

This is an asynchronous process. The policy will not be fully deleted yet when the response returns.

This operation is performed by calling function DeleteLegalHoldPolicyById.

See the endpoint docs at API Reference.

await client.LegalHoldPolicies.DeleteLegalHoldPolicyByIdAsync(legalHoldPolicyId: legalHoldPolicyId);

Arguments

  • legalHoldPolicyId string
    • The ID of the legal hold policy Example: "324432"
  • headers DeleteLegalHoldPolicyByIdHeaders
    • Headers of deleteLegalHoldPolicyById method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type null.

A blank response is returned if the policy was successfully deleted.