FoldersResource
Defined in: libs/ccs-files-user-client/src/core/resources/folders.ts:18
Folders of the client’s context. "root" is accepted wherever a folder id is.
Methods
Section titled “Methods”root()
Section titled “root()”root():
Promise<Folder>
Defined in: libs/ccs-files-user-client/src/core/resources/folders.ts:22
The application’s root folder (folder_id: "root", parent_id: null, path: "/").
Returns
Section titled “Returns”Promise<Folder>
create()
Section titled “create()”create(
input):Promise<Folder>
Defined in: libs/ccs-files-user-client/src/core/resources/folders.ts:27
Creates a folder under parent_id (edit on the parent). Carries an Idempotency-Key.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Folder>
get(
folderId):Promise<Folder>
Defined in: libs/ccs-files-user-client/src/core/resources/folders.ts:34
Parameters
Section titled “Parameters”folderId
Section titled “folderId”string
Returns
Section titled “Returns”Promise<Folder>
children()
Section titled “children()”Defined in: libs/ccs-files-user-client/src/core/resources/folders.ts:39
One page of children, folders first when sort=name; filtered to what the user may view.
Parameters
Section titled “Parameters”folderId
Section titled “folderId”string
query?
Section titled “query?”ChildrenQuery = {}
Returns
Section titled “Returns”path()
Section titled “path()”path(
folderId):Promise<FolderPath>
Defined in: libs/ccs-files-user-client/src/core/resources/folders.ts:56
The breadcrumb from the root down.
Parameters
Section titled “Parameters”folderId
Section titled “folderId”string
Returns
Section titled “Returns”Promise<FolderPath>
update()
Section titled “update()”update(
folderId,patch,options?):Promise<Folder>
Defined in: libs/ccs-files-user-client/src/core/resources/folders.ts:61
Renames, describes or moves. { ifMatch: folder.revision } makes it conditional (412 on a stale revision).
Parameters
Section titled “Parameters”folderId
Section titled “folderId”string
options?
Section titled “options?”UpdateOptions = {}
Returns
Section titled “Returns”Promise<Folder>
move()
Section titled “move()”move(
folderId,input,options?):Promise<Folder>
Defined in: libs/ccs-files-user-client/src/core/resources/folders.ts:73
Moves the folder under parent_id; invalid_move into its own subtree.
Parameters
Section titled “Parameters”folderId
Section titled “folderId”string
parent_id
Section titled “parent_id”string
options?
Section titled “options?”UpdateOptions = {}
Returns
Section titled “Returns”Promise<Folder>
copy()
Section titled “copy()”copy(
folderId,input):Promise<FolderCopyResult>
Defined in: libs/ccs-files-user-client/src/core/resources/folders.ts:82
Copies the subtree asynchronously: { job_id, folder }. Carries an Idempotency-Key.
Parameters
Section titled “Parameters”folderId
Section titled “folderId”string
parent_id
Section titled “parent_id”string
string
Returns
Section titled “Returns”Promise<FolderCopyResult>
delete()
Section titled “delete()”delete(
folderId):Promise<JobAccepted|null>
Defined in: libs/ccs-files-user-client/src/core/resources/folders.ts:93
Trashes the folder: { job_id } for a subtree, null for an empty folder.
Parameters
Section titled “Parameters”folderId
Section titled “folderId”string
Returns
Section titled “Returns”Promise<JobAccepted | null>
restore()
Section titled “restore()”restore(
folderId):Promise<JobAccepted>
Defined in: libs/ccs-files-user-client/src/core/resources/folders.ts:102
Restores a trashed folder and its subtree: { job_id }.
Parameters
Section titled “Parameters”folderId
Section titled “folderId”string
Returns
Section titled “Returns”Promise<JobAccepted>
releaseManagement()
Section titled “releaseManagement()”releaseManagement(
folderId,input):Promise<Folder>
Defined in: libs/ccs-files-user-client/src/core/resources/folders.ts:113
Releases an application’s mark on the folder (an emergency action, audited folder.management_released with the
reason): the folder and its subtree become editable again, unless an outer marked folder still covers them. Only the
tenant owner (me.capabilities() answers tenant_owner: true); anyone else gets 403 tenant_owner_required. Call it
on the folder that carries the mark (managed_by.managed_folder_id); any other folder answers 400
invalid_request. Never retried.
Parameters
Section titled “Parameters”folderId
Section titled “folderId”string
Returns
Section titled “Returns”Promise<Folder>