Class Space

Constructors

constructor

Properties

client

Methods

createPrivateSpace createSpace deleteSpace getContentByTypeForSpace getContentForSpace getSpace getSpaces updateSpace

Constructors

constructor

Properties

Private client

client: Client

Methods

createPrivateSpace

  • createPrivateSpace<T>(parameters, callback): Promise<void>

  • Creates a new space that is only visible to the creator. This method is the same as the Create space method with permissions set to the current user only. Note, currently you cannot set space labels when creating a space.

    Permissions required: 'Create Space(s)' global permission.

    Type Parameters

    Parameters

    Returns Promise<void>

  • createPrivateSpace<T>(parameters?, callback?): Promise<T>

  • Creates a new space that is only visible to the creator. This method is the same as the Create space method with permissions set to the current user only. Note, currently you cannot set space labels when creating a space.

    Permissions required: 'Create Space(s)' global permission.

    Type Parameters

    Parameters

    Returns Promise<T>

createSpace

  • createSpace<T>(parameters, callback): Promise<void>

  • Creates a new space. Note, currently you cannot set space labels when creating a space.

    Permissions required: 'Create Space(s)' global permission.

    Type Parameters

    Parameters

    Returns Promise<void>

  • createSpace<T>(parameters?, callback?): Promise<T>

  • Creates a new space. Note, currently you cannot set space labels when creating a space.

    Permissions required: 'Create Space(s)' global permission.

    Type Parameters

    Parameters

    Returns Promise<T>

deleteSpace

  • deleteSpace<T>(parameters, callback): Promise<void>

  • Deletes a space. 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.

    Type Parameters

    Parameters

    Returns Promise<void>

  • deleteSpace<T>(parameters, callback?): Promise<T>

  • Deletes a space. 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.

    Type Parameters

    Parameters

    Returns Promise<T>

getContentByTypeForSpace

  • getContentByTypeForSpace<T>(parameters, callback): Promise<void>

  • Returns all content of a given type, in a space. The returned content is ordered by content ID in ascending order.

    Permissions required: 'View' permission for the space. Note, the returned list will only contain content that the current user has permission to view.

    Type Parameters

    Parameters

    Returns Promise<void>

  • getContentByTypeForSpace<T>(parameters, callback?): Promise<T>

  • Returns all content of a given type, in a space. The returned content is ordered by content ID in ascending order.

    Permissions required: 'View' permission for the space. Note, the returned list will only contain content that the current user has permission to view.

    Type Parameters

    Parameters

    Returns Promise<T>

getContentForSpace

  • getContentForSpace<T>(parameters, callback): Promise<void>

  • Returns all content in a space. The returned content is grouped by type (pages then blogposts), then ordered by content ID in ascending order.

    Permissions required: 'View' permission for the space. Note, the returned list will only contain content that the current user has permission to view.

    Type Parameters

    Parameters

    Returns Promise<void>

  • getContentForSpace<T>(parameters, callback?): Promise<T>

  • Returns all content in a space. The returned content is grouped by type (pages then blogposts), then ordered by content ID in ascending order.

    Permissions required: 'View' permission for the space. Note, the returned list will only contain content that the current user has permission to view.

    Type Parameters

    Parameters

    Returns Promise<T>

getSpace

  • getSpace<T>(parameters, callback): Promise<void>

  • Returns a space. This includes information like the name, description, and permissions, but not the content in the space.

    Permissions required: 'View' permission for the space.

    Type Parameters

    Parameters

    Returns Promise<void>

  • getSpace<T>(parameters, callback?): Promise<T>

  • Returns a space. This includes information like the name, description, and permissions, but not the content in the space.

    Permissions required: 'View' permission for the space.

    Type Parameters

    Parameters

    Returns Promise<T>

getSpaces

  • getSpaces<T>(parameters, callback): Promise<void>

  • Returns all spaces. The returned spaces are ordered alphabetically in ascending order by space key.

    Permissions required: Permission to access the Confluence site ('Can use' global permission). Note, the returned list will only contain spaces that the current user has permission to view.

    Type Parameters

    Parameters

    Returns Promise<void>

  • getSpaces<T>(parameters?, callback?): Promise<T>

  • Returns all spaces. The returned spaces are ordered alphabetically in ascending order by space key.

    Permissions required: Permission to access the Confluence site ('Can use' global permission). Note, the returned list will only contain spaces that the current user has permission to view.

    Type Parameters

    Parameters

    Returns Promise<T>

updateSpace

  • updateSpace<T>(parameters, callback): Promise<void>

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

    Type Parameters

    Parameters

    Returns Promise<void>

  • updateSpace<T>(parameters, callback?): Promise<T>

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

    Type Parameters

    Parameters

    Returns Promise<T>

Settings

Member Visibility

Theme

On This Page

constructorclientcreatePrivateSpacecreateSpacedeleteSpacegetContentByTypeForSpacegetContentForSpacegetSpacegetSpacesupdateSpace

Generated using TypeDoc v0.25.12