Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.33 KB

fileVersionRetentions.md

File metadata and controls

74 lines (49 loc) · 2.33 KB

FileVersionRetentionsManager

List file version retentions

Retrieves all file version retentions for the given enterprise.

Note: File retention API is now deprecated. To get information about files and file versions under retention, see files under retention or file versions under retention endpoints.

This operation is performed by calling function getFileVersionRetentions.

See the endpoint docs at API Reference.

await client.fileVersionRetentions.getFileVersionRetentions();

Arguments

  • queryParams GetFileVersionRetentionsQueryParams
    • Query parameters of getFileVersionRetentions method
  • headersInput GetFileVersionRetentionsHeadersInput
    • Headers of getFileVersionRetentions method
  • cancellationToken undefined | CancellationToken
    • Token used for request cancellation.

Returns

This function returns a value of type FileVersionRetentions.

Returns a list of all file version retentions for the enterprise.

Get retention on file

Returns information about a file version retention.

Note: File retention API is now deprecated. To get information about files and file versions under retention, see files under retention or file versions under retention endpoints.

This operation is performed by calling function getFileVersionRetentionById.

See the endpoint docs at API Reference.

await client.fileVersionRetentions.getFileVersionRetentionById(
  fileVersionRetention.id!,
);

Arguments

  • fileVersionRetentionId string
    • The ID of the file version retention Example: "3424234"

  • optionalsInput GetFileVersionRetentionByIdOptionalsInput

Returns

This function returns a value of type FileVersionRetention.

Returns a file version retention object.