File

Defined in: libs/ccs-files-user-client/src/core/types.ts:154

A file. my_actions holds what the signed-in user may do with it.

Properties

type

type: "file"

Defined in: libs/ccs-files-user-client/src/core/types.ts:155

---

file_id

file_id: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:156

---

tenant_id

tenant_id: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:157

---

application_id

application_id: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:158

---

folder_id

folder_id: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:159

---

path

path: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:160

---

name

name: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:161

---

extension

extension: string | null

Defined in: libs/ccs-files-user-client/src/core/types.ts:162

---

mime_type

mime_type: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:163

---

kind

kind: FileKind

Defined in: libs/ccs-files-user-client/src/core/types.ts:164

---

size

size: number

Defined in: libs/ccs-files-user-client/src/core/types.ts:165

---

content_sha256

content_sha256: string | null

Defined in: libs/ccs-files-user-client/src/core/types.ts:166

---

title

title: string | null

Defined in: libs/ccs-files-user-client/src/core/types.ts:167

---

description

description: string | null

Defined in: libs/ccs-files-user-client/src/core/types.ts:168

---

category

category: string | null

Defined in: libs/ccs-files-user-client/src/core/types.ts:169

---

department

department: string | null

Defined in: libs/ccs-files-user-client/src/core/types.ts:170

---

tags

tags: string[]

Defined in: libs/ccs-files-user-client/src/core/types.ts:171

---

custom

custom: Record<string, string>

Defined in: libs/ccs-files-user-client/src/core/types.ts:172

---

external_ref

external_ref: string | null

Defined in: libs/ccs-files-user-client/src/core/types.ts:173

---

owner_id

owner_id: string | null

Defined in: libs/ccs-files-user-client/src/core/types.ts:174

---

created_by

created_by: CreatedBy

Defined in: libs/ccs-files-user-client/src/core/types.ts:175

---

created_at

created_at: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:176

---

updated_at

updated_at: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:177

---

state

state: FileState

Defined in: libs/ccs-files-user-client/src/core/types.ts:178

---

status

status: FileStatus

Defined in: libs/ccs-files-user-client/src/core/types.ts:179

---

visibility

visibility: Visibility

Defined in: libs/ccs-files-user-client/src/core/types.ts:180

---

public_url

public_url: string | null

Defined in: libs/ccs-files-user-client/src/core/types.ts:181

---

current_version_no

current_version_no: number

Defined in: libs/ccs-files-user-client/src/core/types.ts:182

---

versions_count

versions_count: number

Defined in: libs/ccs-files-user-client/src/core/types.ts:183

---

revision

revision: number

Defined in: libs/ccs-files-user-client/src/core/types.ts:185

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

---

media

media: Record<string, unknown>

Defined in: libs/ccs-files-user-client/src/core/types.ts:186

---

processing

processing: Processing

Defined in: libs/ccs-files-user-client/src/core/types.ts:187

---

renditions

renditions: Partial<Record<RenditionName, RenditionInfo>>

Defined in: libs/ccs-files-user-client/src/core/types.ts:188

---

public_renditions

public_renditions: Record<string, string> | null

Defined in: libs/ccs-files-user-client/src/core/types.ts:189

---

duplicate_of

duplicate_of: string | null

Defined in: libs/ccs-files-user-client/src/core/types.ts:190

---

lock

lock: FileLock | null

Defined in: libs/ccs-files-user-client/src/core/types.ts:191

---

editable

editable: boolean

Defined in: libs/ccs-files-user-client/src/core/types.ts:192

---

hold

hold: FileHold | null

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

The legal hold, or null.

---

managed

managed: boolean

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

true for a folder an application manages and everything below it: read-only for people (403 folder_managed), changed only by the application’s backend. isReadOnly(item) reads it.

---

managed_by

managed_by: ManagedBy | null

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

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

---

inherit

inherit: boolean

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

---

acl_scope_id

acl_scope_id: string

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

---

entries_count

entries_count: number

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

---

trashed_at

trashed_at: string | null

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

---

trashed_by

trashed_by: string | null

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

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

---

my_actions

my_actions: FileAction[]

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

---

original_path?

optional original_path?: string

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

Present on trash listings.

---

job_id?

optional job_id?: string

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

Present on an asynchronous completion (multipart above 1,000 parts).

---

entries?

optional entries?: AccessEntry[]

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

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

---

versions?

optional versions?: Version[]

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

---

shares?

optional shares?: Share[]

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