HoldResource
Defined in: libs/ccs-files-user-client/src/core/resources/files.ts:137
The legal hold of a file (PUT / DELETE P/files/:file_id/hold). Needs the files.manage permission (else 403
missing_capability). While a hold is in force the file cannot be purged and its versions cannot be deleted (409
file_on_hold); trashing, restoring, edits and new versions stay allowed.
Methods
Section titled “Methods”place()
Section titled “place()”place(
fileId,input):Promise<File>
Defined in: libs/ccs-files-user-client/src/core/resources/files.ts:148
Places a hold, or replaces the reason and the end of the one in place (who placed it and when stay). Resolves
with the File and its hold. A pending upload answers 409 file_pending.
Parameters
Section titled “Parameters”fileId
Section titled “fileId”string
Returns
Section titled “Returns”Promise<File>
release()
Section titled “release()”release(
fileId,input?):Promise<File>
Defined in: libs/ccs-files-user-client/src/core/resources/files.ts:153
Releases the hold; the optional reason is kept in the audit log. A file without a hold resolves unchanged.
Parameters
Section titled “Parameters”fileId
Section titled “fileId”string
input?
Section titled “input?”ReleaseHoldInput = {}
Returns
Section titled “Returns”Promise<File>