Preview
Defined in: libs/ccs-files-user-client/src/core/types.ts:542
GET P/files/:file_id/preview: what a viewer needs in one call.
Properties
Section titled “Properties”kind:
PreviewKind
Defined in: libs/ccs-files-user-client/src/core/types.ts:544
none with url: null when nothing can be shown (yet).
url:
string|null
Defined in: libs/ccs-files-user-client/src/core/types.ts:549
The URL to show: for an image the preview rendition when ready, for a video the first ready mp4_*
rendition, else the original. playbackSources(preview) lists every playable video URL.
expires_at
Section titled “expires_at”expires_at:
string|null
Defined in: libs/ccs-files-user-client/src/core/types.ts:550
mime_type
Section titled “mime_type”mime_type:
string|null
Defined in: libs/ccs-files-user-client/src/core/types.ts:551
renditions
Section titled “renditions”renditions:
Partial<Record<RenditionName, {status:RenditionStatus;url?:string;width?:number|null;height?:number|null; }>>
Defined in: libs/ccs-files-user-client/src/core/types.ts:552
optionaltext?:object
Defined in: libs/ccs-files-user-client/src/core/types.ts:564
Text files: the same URL served as UTF-8 text, and whether the file is larger than the 1 MiB preview cap.
url:
string
truncated
Section titled “truncated”truncated:
boolean
editable
Section titled “editable”editable:
boolean
Defined in: libs/ccs-files-user-client/src/core/types.ts:565