FileHold
Defined in: libs/ccs-files-client/src/types.ts:135
A legal hold on a file (files.hold.place). While it is in force the file cannot be purged (by anyone, nor by the
trash’s retention or emptying) and its versions are neither deleted nor pruned (409 file_on_hold); it can still be
trashed, restored, edited and given new versions. A hold whose until has passed blocks nothing; the service clears
it within a day (audited hold.released with reason: 'expired').
Properties
Section titled “Properties”reason
Section titled “reason”reason:
string
Defined in: libs/ccs-files-client/src/types.ts:137
Why the file is held; shown to everyone who can view the file.
placed_by
Section titled “placed_by”placed_by:
string
Defined in: libs/ccs-files-client/src/types.ts:139
The user who placed it (a machine’s acting_user_id), or the client id of a machine caller without one.
placed_at
Section titled “placed_at”placed_at:
string
Defined in: libs/ccs-files-client/src/types.ts:140
until:
string|null
Defined in: libs/ccs-files-client/src/types.ts:142
When the hold ends by itself; null: until released.