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

    Class ContentWatches

    Index

    Constructors

    Methods

    • Adds a user as a watcher to a piece of content. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<void>

    • Adds a user as a watcher to a piece of content. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<T>

    • Adds a user as a watcher to a label. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<void>

    • Adds a user as a watcher to a label. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<T>

    • Adds a user as a watcher to a space. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<void>

    • Adds a user as a watcher to a space. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<T>

    • Returns whether a user is watching a piece of content. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      Parameters

      Returns Promise<void>

    • Returns whether a user is watching a piece of content. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      Parameters

      Returns Promise<T>

    • Returns whether a user is watching a label. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      Parameters

      Returns Promise<void>

    • Returns whether a user is watching a label. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      Parameters

      Returns Promise<T>

    • Returns whether a user is watching a space. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      Parameters

      Returns Promise<void>

    • Returns whether a user is watching a space. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      Parameters

      Returns Promise<T>

    • Removes a user as a watcher from a piece of content. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<void>

    • Removes a user as a watcher from a piece of content. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<T>

    • Removes a user as a watcher from a label. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<void>

    • Removes a user as a watcher from a label. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<T>

    • Removes a user as a watcher from a space. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<void>

    • Removes a user as a watcher from a space. Choose the user by doing one of the following:

      • Specify a user via a query parameter: Use the accountId to identify the user.
      • Do not specify a user: The currently logged-in user will be used.

      Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

      Type Parameters

      • T = void

      Parameters

      Returns Promise<T>