Folder
Defined in: libs/ccs-files-user-client/src/core/types.ts:223
A folder. The application root is folder_id: "root", parent_id: null, path: "/".
Properties
Section titled “Properties”type:
"folder"
Defined in: libs/ccs-files-user-client/src/core/types.ts:224
folder_id
Section titled “folder_id”folder_id:
string
Defined in: libs/ccs-files-user-client/src/core/types.ts:225
tenant_id
Section titled “tenant_id”tenant_id:
string
Defined in: libs/ccs-files-user-client/src/core/types.ts:226
application_id
Section titled “application_id”application_id:
string
Defined in: libs/ccs-files-user-client/src/core/types.ts:227
parent_id
Section titled “parent_id”parent_id:
string|null
Defined in: libs/ccs-files-user-client/src/core/types.ts:228
name:
string
Defined in: libs/ccs-files-user-client/src/core/types.ts:229
path:
string
Defined in: libs/ccs-files-user-client/src/core/types.ts:230
depth:
number
Defined in: libs/ccs-files-user-client/src/core/types.ts:231
description
Section titled “description”description:
string|null
Defined in: libs/ccs-files-user-client/src/core/types.ts:232
owner_id
Section titled “owner_id”owner_id:
string|null
Defined in: libs/ccs-files-user-client/src/core/types.ts:233
created_by
Section titled “created_by”created_by:
CreatedBy|null
Defined in: libs/ccs-files-user-client/src/core/types.ts:234
inherit
Section titled “inherit”inherit:
boolean
Defined in: libs/ccs-files-user-client/src/core/types.ts:235
acl_scope_id
Section titled “acl_scope_id”acl_scope_id:
string
Defined in: libs/ccs-files-user-client/src/core/types.ts:236
entries_count
Section titled “entries_count”entries_count:
number
Defined in: libs/ccs-files-user-client/src/core/types.ts:237
state:
"available"|"trashed"
Defined in: libs/ccs-files-user-client/src/core/types.ts:238
revision
Section titled “revision”revision:
number
Defined in: libs/ccs-files-user-client/src/core/types.ts:240
Optimistic concurrency: pass it as { ifMatch } to folders.update.
metadata
Section titled “metadata”metadata:
Record<string,string>
Defined in: libs/ccs-files-user-client/src/core/types.ts:241
external_ref
Section titled “external_ref”external_ref:
string|null
Defined in: libs/ccs-files-user-client/src/core/types.ts:242
busy:
boolean
Defined in: libs/ccs-files-user-client/src/core/types.ts:244
A subtree job (copy, trash, restore) is running on the folder.
managed
Section titled “managed”managed:
boolean
Defined in: libs/ccs-files-user-client/src/core/types.ts:249
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
Section titled “managed_by”managed_by:
ManagedBy|null
Defined in: libs/ccs-files-user-client/src/core/types.ts:251
Who manages the item and which folder carries the mark; null when managed is false.
created_at
Section titled “created_at”created_at:
string
Defined in: libs/ccs-files-user-client/src/core/types.ts:252
updated_at
Section titled “updated_at”updated_at:
string
Defined in: libs/ccs-files-user-client/src/core/types.ts:253
trashed_at
Section titled “trashed_at”trashed_at:
string|null
Defined in: libs/ccs-files-user-client/src/core/types.ts:254
trashed_by
Section titled “trashed_by”trashed_by:
string|null
Defined in: libs/ccs-files-user-client/src/core/types.ts:255
my_actions
Section titled “my_actions”my_actions:
FileAction[]
Defined in: libs/ccs-files-user-client/src/core/types.ts:256
original_path?
Section titled “original_path?”
optionaloriginal_path?:string
Defined in: libs/ccs-files-user-client/src/core/types.ts:257