Folder
Defined in: libs/ccs-files-client/src/types.ts:277
A folder. The application root is folder_id: "root", parent_id: null, path: "/".
Properties
Section titled “Properties”type:
"folder"
Defined in: libs/ccs-files-client/src/types.ts:278
folder_id
Section titled “folder_id”folder_id:
string
Defined in: libs/ccs-files-client/src/types.ts:279
tenant_id
Section titled “tenant_id”tenant_id:
string
Defined in: libs/ccs-files-client/src/types.ts:280
application_id
Section titled “application_id”application_id:
string
Defined in: libs/ccs-files-client/src/types.ts:281
parent_id
Section titled “parent_id”parent_id:
string|null
Defined in: libs/ccs-files-client/src/types.ts:282
path:
string
Defined in: libs/ccs-files-client/src/types.ts:283
name:
string
Defined in: libs/ccs-files-client/src/types.ts:284
depth:
number
Defined in: libs/ccs-files-client/src/types.ts:286
0 for the root.
description
Section titled “description”description:
string|null
Defined in: libs/ccs-files-client/src/types.ts:287
owner_id
Section titled “owner_id”owner_id:
string|null
Defined in: libs/ccs-files-client/src/types.ts:288
created_by
Section titled “created_by”created_by:
CreatedBy|null
Defined in: libs/ccs-files-client/src/types.ts:290
null for the root.
created_at
Section titled “created_at”created_at:
string|null
Defined in: libs/ccs-files-client/src/types.ts:292
null for the root.
updated_at
Section titled “updated_at”updated_at:
string|null
Defined in: libs/ccs-files-client/src/types.ts:293
state:
"available"|"trashed"
Defined in: libs/ccs-files-client/src/types.ts:294
revision
Section titled “revision”revision:
number
Defined in: libs/ccs-files-client/src/types.ts:296
Optimistic concurrency: pass it as { ifMatch } to folders.update.
metadata
Section titled “metadata”metadata:
Record<string,string>
Defined in: libs/ccs-files-client/src/types.ts:297
inherit
Section titled “inherit”inherit:
boolean
Defined in: libs/ccs-files-client/src/types.ts:298
acl_scope_id
Section titled “acl_scope_id”acl_scope_id:
string
Defined in: libs/ccs-files-client/src/types.ts:299
entries_count
Section titled “entries_count”entries_count:
number
Defined in: libs/ccs-files-client/src/types.ts:300
external_ref
Section titled “external_ref”external_ref:
string|null
Defined in: libs/ccs-files-client/src/types.ts:302
Your own id for the folder (Chat keeps one folder per conversation); a list filter.
busy:
boolean
Defined in: libs/ccs-files-client/src/types.ts:304
A subtree job (copy, trash, restore) is running on the folder.
managed
Section titled “managed”managed:
boolean
Defined in: libs/ccs-files-client/src/types.ts:309
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
Section titled “managed_by”managed_by:
ManagedBy|null
Defined in: libs/ccs-files-client/src/types.ts:311
Who manages the item and which folder carries the mark; null when managed is false.
trashed_at
Section titled “trashed_at”trashed_at:
string|null
Defined in: libs/ccs-files-client/src/types.ts:312
trashed_by
Section titled “trashed_by”trashed_by:
string|null
Defined in: libs/ccs-files-client/src/types.ts:313
my_actions
Section titled “my_actions”my_actions:
FileAction[]
Defined in: libs/ccs-files-client/src/types.ts:314
original_path?
Section titled “original_path?”
optionaloriginal_path?:string
Defined in: libs/ccs-files-client/src/types.ts:315