Confluence.js - Cloud and Server API library
    Preparing search index...

    Class Experimental

    Index

    Constructors

    Methods

    • Moves a pagetree rooted at a page to the space's trash:

      • If the content's type is page and its status is current, it will be trashed including all its descendants.
      • For every other combination of content type and status, this API is not supported.

      This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.

      Use the /longtask/<taskId> REST API to get the copy task status.

      Permissions required: 'Delete' permission for the space that the content is in.

      Type Parameters

      Parameters

      Returns Promise<void>

    • Moves a pagetree rooted at a page to the space's trash:

      • If the content's type is page and its status is current, it will be trashed including all its descendants.
      • For every other combination of content type and status, this API is not supported.

      This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.

      Use the /longtask/<taskId> REST API to get the copy task status.

      Permissions required: 'Delete' permission for the space that the content is in.

      Type Parameters

      Parameters

      Returns Promise<T>

    • Deletes a property for the given user. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

      Permissions required: Permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<void>

    • Deletes a property for the given user. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

      Permissions required: Permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<T>

    • Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

      Permissions required: Permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<void>

    • Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

      Permissions required: Permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<T>