Class FolderService

Service for interacting with folders.

Implements

FolderServiceInterface

Index

Constructors

Methods

createFolder deleteFolder getFolder updateFolder

Constructors

constructor

new FolderService(
connectClient: ConnectClientInterface,
folderMapper: FolderMapper,
): FolderService
Parameters
- connectClient: ConnectClientInterface
  The Connect client to use for API calls.
- folderMapper: FolderMapper
  The mapper to use for converting API data to domain data.
Returns FolderService
- Defined in service/FolderService.ts:21

Methods

createFolder

createFolder(
    name: string,
    projectId: string,
    parentFolderId: string,
): Promise<CreateFolderResult>
Create a new folder in a specified project and parent folder.
Parameters
- 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>
Implementation of FolderServiceInterface.createFolder
- Defined in service/FolderService.ts:75

deleteFolder

deleteFolder(folderId: string, projectId: string): Promise<DeleteFolderResult>
Delete a folder.
Parameters
- folderId: string
  The ID of the folder to delete.
- projectId: string
  The ID of the project to which the folder belongs.
Returns Promise<DeleteFolderResult>
Implementation of FolderServiceInterface.deleteFolder
- Defined in service/FolderService.ts:52

getFolder

getFolder(folderId: string): Promise<GetFolderResult>
Get specified folder.
Parameters
- folderId: string
  The ID of the folder to get.
Returns Promise<GetFolderResult>
Implementation of FolderServiceInterface.getFolder
- Defined in service/FolderService.ts:29

updateFolder

updateFolder(
    name: string,
    projectId: string,
    folderId: string,
): 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
- 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>
Implementation of FolderServiceInterface.updateFolder
- Defined in service/FolderService.ts:104