Class SpaceService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space

Hierarchy

  • CommonHttpService
    • SpaceService

Constructors

constructor

Methods

createPrivateSpace createSpace deleteSpace updateSpace initialize

Constructors

constructor

  • new SpaceService(getClientInstance): SpaceService
  • Internal

    Create a new instance of the service.

    Parameters

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

        • Returns CommonHttpClient

    Returns SpaceService

Methods

createPrivateSpace

createSpace

deleteSpace

  • deleteSpace(params): Promise<LongTask>

  • Permanently deletes a space without sending it to the trash. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted yet when this method has returned. Clients should poll the status link that is returned in the response until the task completes.

    Permissions required: 'Admin' permission for the space.

    Parameters

    • params: {
          spaceKey: string;
      }
      • spaceKey: string

        The key of the space to delete.

    Returns Promise<LongTask>

    Returns a pointer to the status of the space deletion task.

    Path

    DELETE /wiki/rest/api/space/{spaceKey} @scopes-current write:confluence-space @scopes-beta read:content.metadata:confluence, delete:space:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-delete

updateSpace

  • updateSpace(params): Promise<null | Space>

  • Updates the name, description, or homepage of a space.

    • For security reasons, permissions cannot be updated via the API and must be changed via the user interface instead.
    • Currently you cannot set space labels when updating a space.

    Permissions required: 'Admin' permission for the space.

    Parameters

    • params: {
          spaceKey: string;
          spaceUpdate: SpaceUpdate;
      }
      • spaceKey: string

        The key of the space to update.

      • spaceUpdate: SpaceUpdate

        The updated space.

    Returns Promise<null | Space>

    Returned if the space is updated.

    Path

    PUT /wiki/rest/api/space/{spaceKey} @scopes-current write:confluence-space @scopes-beta read:space-details:confluence, write:space:confluence, write:space.permission:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-put

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