Interface: FolderServiceInterface
Methods
createFolder()
createFolder(
name
,projectId
,parentFolderId
):Promise
<CreateFolderResult
>
Create a new folder in a specified project and parent folder.
Parameters
Parameter | Type | Description |
---|---|---|
name | string | The name of the folder to create. |
projectId | string | The ID of the project to which the folder belongs. |
parentFolderId | string | The ID of the parent folder. |
Returns
Promise
<CreateFolderResult
>
Defined in
service/FolderServiceInterface.ts:35 (opens in a new tab)
deleteFolder()
deleteFolder(
folderId
,projectId
):Promise
<DeleteFolderResult
>
Delete a folder.
Parameters
Parameter | Type | Description |
---|---|---|
folderId | string | The ID of the folder to delete. |
projectId | string | The ID of the project to which the folder belongs. |
Returns
Promise
<DeleteFolderResult
>
Defined in
service/FolderServiceInterface.ts:27 (opens in a new tab)
getFolder()
getFolder(
folderId
):Promise
<GetFolderResult
>
Get specified folder.
Parameters
Parameter | Type | Description |
---|---|---|
folderId | string | The ID of the folder to get. |
Returns
Promise
<GetFolderResult
>
Defined in
service/FolderServiceInterface.ts:21 (opens in a new tab)
updateFolder()
updateFolder(
name
,projectId
,folderId
):Promise
<UpdateFolderResult
>
Update a folders parameters. This can be used to rename a folder or to move it to a different parent folder and/or project.
Parameters
Parameter | Type | Description |
---|---|---|
name | string | The new name of the folder. |
projectId | string | The ID of the project to which the folder belongs. |
folderId | string | The ID of the folder to update. |
Returns
Promise
<UpdateFolderResult
>