Class FolderService

See

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder

Hierarchy

  • CommonHttpService
    • FolderService

Constructors

constructor

Methods

createFolder deleteFolder getFolderById initialize

Constructors

constructor

  • new FolderService(getClientInstance): FolderService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns FolderService

Methods

createFolder

  • createFolder(params): Promise<FolderSingle & {
        _links?: {
            base?: string;
        } & {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

  • Creates a folder in the space.

    Permissions required: Permission to view the corresponding space. Permission to create a folder in the space.

    Parameters

    • params: {
          requestBody: {
              parentId?: string;
              spaceId: string;
              title?: string;
          } & {
              [key: string]: unknown;
          };
      }
      • requestBody: {
            parentId?: string;
            spaceId: string;
            title?: string;
        } & {
            [key: string]: unknown;
        }

    Returns Promise<FolderSingle & {
        _links?: {
            base?: string;
        } & {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

    Returned if the folder was successfully created in the content tree.

    Path

    POST /folders @scopes-current write:folder:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder#api-folders-post

deleteFolder

  • deleteFolder(params): Promise<void>

  • Delete a folder by id.

    Deleting a folder moves the folder to the trash, where it can be restored later

    Permissions required: Permission to view the folder and its corresponding space. Permission to delete folders in the space.

    Parameters

    • params: {
          id: number;
      }
      • id: number

        The ID of the folder to be deleted.

    Returns Promise<void>

    Path

    DELETE /folders/{id} @scopes-current delete:folder:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder#api-folders-id-delete

getFolderById

  • getFolderById(params): Promise<FolderSingle & {
        _links?: {
            base?: string;
        } & {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

  • Returns a specific folder.

    Permissions required: Permission to view the folder and its corresponding space.

    Parameters

    • params: {
          id: number;
          includeCollaborators?: boolean;
          includeDirectChildren?: boolean;
          includeOperations?: boolean;
          includeProperties?: boolean;
      }
      • id: number

        The ID of the folder to be returned.

      • OptionalincludeCollaborators?: boolean

        Includes collaborators on the folder.

      • OptionalincludeDirectChildren?: boolean

        Includes direct children of the folder, as defined in the ChildrenResponse object.

      • OptionalincludeOperations?: boolean

        Includes operations associated with this folder in the response, as defined in the Operation object. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

      • OptionalincludeProperties?: boolean

        Includes content properties associated with this folder in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

    Returns Promise<FolderSingle & {
        _links?: {
            base?: string;
        } & {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

    Returned if the requested folder is returned.

    Path

    GET /folders/{id} @scopes-current read:folder:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder#api-folders-id-get

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods