Documentation
    Preparing search index...

    Interface FolderServiceInterface

    interface FolderServiceInterface {
        createFolder(
            name: string,
            projectId: string,
            parentFolderId: string,
        ): Promise<CreateFolderResult>;
        deleteFolder(
            folderId: string,
            projectId: string,
        ): Promise<DeleteFolderResult>;
        getFolder(folderId: string): Promise<GetFolderResult>;
        updateFolder(
            name: string,
            projectId: string,
            folderId: string,
        ): Promise<UpdateFolderResult>;
    }

    Implemented by

    Index

    Methods

    createFolder deleteFolder getFolder updateFolder

    Methods

    • 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>

    • 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>

    Settings

    Member Visibility

    On This Page

    Methods