File

Defined in: libs/ccs-files-client/src/types.ts:193

A file. my_actions holds the caller’s actions; for a machine token, the scope’s actions.

Properties

type

type: "file"

Defined in: libs/ccs-files-client/src/types.ts:194

---

file_id

file_id: string

Defined in: libs/ccs-files-client/src/types.ts:195

---

tenant_id

tenant_id: string

Defined in: libs/ccs-files-client/src/types.ts:196

---

application_id

application_id: string

Defined in: libs/ccs-files-client/src/types.ts:197

---

folder_id

folder_id: string

Defined in: libs/ccs-files-client/src/types.ts:198

---

path

path: string

Defined in: libs/ccs-files-client/src/types.ts:199

---

name

name: string

Defined in: libs/ccs-files-client/src/types.ts:200

---

extension

extension: string | null

Defined in: libs/ccs-files-client/src/types.ts:201

---

mime_type

mime_type: string

Defined in: libs/ccs-files-client/src/types.ts:202

---

kind

kind: FileKind

Defined in: libs/ccs-files-client/src/types.ts:203

---

size

size: number

Defined in: libs/ccs-files-client/src/types.ts:204

---

content_sha256

content_sha256: string | null

Defined in: libs/ccs-files-client/src/types.ts:205

---

title

title: string | null

Defined in: libs/ccs-files-client/src/types.ts:206

---

description

description: string | null

Defined in: libs/ccs-files-client/src/types.ts:207

---

category

category: string | null

Defined in: libs/ccs-files-client/src/types.ts:208

---

department

department: string | null

Defined in: libs/ccs-files-client/src/types.ts:209

---

tags

tags: string[]

Defined in: libs/ccs-files-client/src/types.ts:210

---

custom

custom: Record<string, string>

Defined in: libs/ccs-files-client/src/types.ts:211

---

external_ref

external_ref: string | null

Defined in: libs/ccs-files-client/src/types.ts:212

---

owner_id

owner_id: string | null

Defined in: libs/ccs-files-client/src/types.ts:213

---

created_by

created_by: CreatedBy

Defined in: libs/ccs-files-client/src/types.ts:214

---

created_at

created_at: string

Defined in: libs/ccs-files-client/src/types.ts:215

---

updated_at

updated_at: string

Defined in: libs/ccs-files-client/src/types.ts:216

---

state

state: FileState

Defined in: libs/ccs-files-client/src/types.ts:217

---

status

status: FileStatus

Defined in: libs/ccs-files-client/src/types.ts:218

---

visibility

visibility: Visibility

Defined in: libs/ccs-files-client/src/types.ts:219

---

public_url

public_url: string | null

Defined in: libs/ccs-files-client/src/types.ts:220

---

current_version_no

current_version_no: number

Defined in: libs/ccs-files-client/src/types.ts:221

---

versions_count

versions_count: number

Defined in: libs/ccs-files-client/src/types.ts:222

---

revision

revision: number

Defined in: libs/ccs-files-client/src/types.ts:224

Optimistic concurrency: pass it as { ifMatch } to files.update.

---

media

media: FileMedia

Defined in: libs/ccs-files-client/src/types.ts:225

---

processing

processing: Processing

Defined in: libs/ccs-files-client/src/types.ts:226

---

renditions

renditions: Partial<Record<RenditionName, RenditionInfo>>

Defined in: libs/ccs-files-client/src/types.ts:227

---

public_renditions

public_renditions: Record<string, string> | null

Defined in: libs/ccs-files-client/src/types.ts:228

---

duplicate_of

duplicate_of: string | null

Defined in: libs/ccs-files-client/src/types.ts:229

---

lock

lock: FileLock | null

Defined in: libs/ccs-files-client/src/types.ts:230

---

editable

editable: boolean

Defined in: libs/ccs-files-client/src/types.ts:231

---

hold

hold: FileHold | null

Defined in: libs/ccs-files-client/src/types.ts:232

---

managed

managed: boolean

Defined in: libs/ccs-files-client/src/types.ts:237

true for a folder an application manages and everything below it: people cannot change it (403 folder_managed), only the application’s machine clients with files:manage do.

---

managed_by

managed_by: ManagedBy | null

Defined in: libs/ccs-files-client/src/types.ts:239

Who manages the item and which folder carries the mark; null when managed is false.

---

inherit

inherit: boolean

Defined in: libs/ccs-files-client/src/types.ts:240

---

acl_scope_id

acl_scope_id: string

Defined in: libs/ccs-files-client/src/types.ts:241

---

entries_count

entries_count: number

Defined in: libs/ccs-files-client/src/types.ts:242

---

trashed_at

trashed_at: string | null

Defined in: libs/ccs-files-client/src/types.ts:243

---

trashed_by

trashed_by: string | null

Defined in: libs/ccs-files-client/src/types.ts:245

'system' when processing rejected the file (type, policy or hash); otherwise who trashed it.

---

trash_reason?

optional trash_reason?: string | null

Defined in: libs/ccs-files-client/src/types.ts:247

On a trashed file: why the system trashed it (a rejection by processing), null otherwise.

---

my_actions

my_actions: FileAction[]

Defined in: libs/ccs-files-client/src/types.ts:248

---

original_path?

optional original_path?: string

Defined in: libs/ccs-files-client/src/types.ts:250

Present on trash listings.

---

job_id?

optional job_id?: string

Defined in: libs/ccs-files-client/src/types.ts:252

Present on a 202 completion (multipart above 1,000 parts).

---

entries?

optional entries?: AccessEntry[]

Defined in: libs/ccs-files-client/src/types.ts:254

files.get(id, { include }) adds the requested lists.

---

versions?

optional versions?: Version[]

Defined in: libs/ccs-files-client/src/types.ts:255

---

shares?

optional shares?: Share[]

Defined in: libs/ccs-files-client/src/types.ts:256