SDK
API Documentation
folder
interfaces
Folderserviceinterface

Interface: FolderServiceInterface

Methods

createFolder()

createFolder(name, projectId, parentFolderId): Promise<CreateFolderResult>

Create a new folder in a specified project and parent folder.

Parameters

ParameterTypeDescription
namestringThe name of the folder to create.
projectIdstringThe ID of the project to which the folder belongs.
parentFolderIdstringThe 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

ParameterTypeDescription
folderIdstringThe ID of the folder to delete.
projectIdstringThe 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

ParameterTypeDescription
folderIdstringThe 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

ParameterTypeDescription
namestringThe new name of the folder.
projectIdstringThe ID of the project to which the folder belongs.
folderIdstringThe ID of the folder to update.

Returns

Promise<UpdateFolderResult>

Defined in

service/FolderServiceInterface.ts:44 (opens in a new tab)