Class ContentWatchesService

See

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

Hierarchy

CommonHttpService
- ContentWatchesService

Index

Constructors

Methods

addContentWatcher addLabelWatcher addSpaceWatcher getContentWatchStatus getWatchersForSpace getWatchesForPage getWatchesForSpace isWatchingLabel isWatchingSpace removeContentWatcher removeLabelWatcher removeSpaceWatch initialize

Constructors

constructor

new ContentWatchesService(getClientInstance): ContentWatchesService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns ContentWatchesService
Inherited from CommonHttpService.constructor

Methods

addContentWatcher

addContentWatcher(params): 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).
Parameters
- params: {
      accountId?: string;
      contentId: string;
      key?: string;
      username?: string;
  }
  - OptionalaccountId?: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
  - contentId: string
    The ID of the content to add the watcher to.
  - Optionalkey?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
  - Optionalusername?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
Returns Promise<void>
Path
POST /wiki/rest/api/user/watch/content/{contentId} @scopes-current write:confluence-content @scopes-beta write:watcher:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-content-contentid-post

addLabelWatcher

addLabelWatcher(params): 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).
Parameters
- params: {
      accountId?: string;
      key?: string;
      labelName: string;
      username?: string;
      xAtlassianToken: string;
  }
  - OptionalaccountId?: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
  - Optionalkey?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
  - labelName: string
    The name of the label to add the watcher to.
  - Optionalusername?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
  - xAtlassianToken: string
    Note, you must add header when making a request, as this operation has XSRF protection.
Returns Promise<void>
Path
POST /wiki/rest/api/user/watch/label/{labelName} @scopes-current write:confluence-content @scopes-beta write:watcher:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-label-labelname-post

addSpaceWatcher

addSpaceWatcher(params): 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).
Parameters
- params: {
      accountId?: string;
      key?: string;
      spaceKey: string;
      username?: string;
      xAtlassianToken: string;
  }
  - OptionalaccountId?: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
  - Optionalkey?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
  - spaceKey: string
    The key of the space to add the watcher to.
  - Optionalusername?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
  - xAtlassianToken: string
    Note, you must add header when making a request, as this operation has XSRF protection.
Returns Promise<void>
Path
POST /wiki/rest/api/user/watch/space/{spaceKey} @scopes-current write:confluence-content @scopes-beta write:watcher:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-space-spacekey-post

getContentWatchStatus

getContentWatchStatus(params): Promise<UserWatch>
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).
Parameters
- params: {
      accountId?: string;
      contentId: string;
      key?: string;
      username?: string;
  }
  - OptionalaccountId?: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
  - contentId: string
    The ID of the content to be queried for whether the specified user is watching it.
  - Optionalkey?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
  - Optionalusername?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
Returns Promise<UserWatch>
Returned if the requested watch status is returned.

Path
GET /wiki/rest/api/user/watch/content/{contentId} @scopes-current read:confluence-content.summary @scopes-beta read:watcher:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-content-contentid-get

getWatchersForSpace

getWatchersForSpace(params): Promise<SpaceWatchArray>
Returns a list of watchers of a space
Parameters
- params: {
      limit?: string;
      spaceKey: string;
      start?: string;
  }
  - Optionallimit?: string
    The limit of the number of items to return, this may be restricted by fixed system limits.
  - spaceKey: string
    The key of the space to get watchers.
  - Optionalstart?: string
    The start point of the collection to return.
Returns Promise<SpaceWatchArray>
Returned if watchers list is returned.

Path
GET /wiki/rest/api/space/{spaceKey}/watch @scopes-current read:watcher:confluence, read:user:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-space-spacekey-watch-get

getWatchesForPage

getWatchesForPage(params): Promise<WatchArray>
Returns the watches for a page. A user that watches a page will receive receive notifications when the page is updated.

If you want to manage watches for a page, use the following user methods:
Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
      id: string;
      limit?: number;
      start?: number;
  }
  - id: string
    The ID of the content to be queried for its watches.
  - Optionallimit?: number
    The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.
  - Optionalstart?: number
    The starting index of the returned watches.
Returns Promise<WatchArray>
Returned if the requested watches are returned.

Path
GET /wiki/rest/api/content/{id}/notification/child-created @scopes-current read:confluence-content.summary @scopes-beta read:watcher:confluence, read:user:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-content-id-notification-child-created-get

getWatchesForSpace

getWatchesForSpace(params): Promise<SpaceWatchArray>
Returns all space watches for the space that the content is in. A user that watches a space will receive receive notifications when any content in the space is updated.

If you want to manage watches for a space, use the following user methods:
Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
      id: string;
      limit?: number;
      start?: number;
  }
  - id: string
    The ID of the content to be queried for its watches.
  - Optionallimit?: number
    The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.
  - Optionalstart?: number
    The starting index of the returned watches.
Returns Promise<SpaceWatchArray>
Returned if the requested watches are returned.

Path
GET /wiki/rest/api/content/{id}/notification/created @scopes-current read:confluence-content.summary @scopes-beta read:watcher:confluence, read:user:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-content-id-notification-created-get

isWatchingLabel

isWatchingLabel(params): Promise<UserWatch>
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).
Parameters
- params: {
      accountId?: string;
      key?: string;
      labelName: string;
      username?: string;
  }
  - OptionalaccountId?: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
  - Optionalkey?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
  - labelName: string
    The name of the label to be queried for whether the specified user is watching it.
  - Optionalusername?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
Returns Promise<UserWatch>
Returned if the requested watch status is returned.

Path
GET /wiki/rest/api/user/watch/label/{labelName} @scopes-current read:confluence-content.summary @scopes-beta read:watcher:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-label-labelname-get

isWatchingSpace

isWatchingSpace(params): Promise<UserWatch>
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).
Parameters
- params: {
      accountId?: string;
      key?: string;
      spaceKey: string;
      username?: string;
  }
  - OptionalaccountId?: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
  - Optionalkey?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
  - spaceKey: string
    The key of the space to be queried for whether the specified user is watching it.
  - Optionalusername?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
Returns Promise<UserWatch>
Returned if the requested watch status is returned.

Path
GET /wiki/rest/api/user/watch/space/{spaceKey} @scopes-current read:confluence-content.summary @scopes-beta read:watcher:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-space-spacekey-get

removeContentWatcher

removeContentWatcher(params): 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).
Parameters
- params: {
      accountId?: string;
      contentId: string;
      key?: string;
      username?: string;
      xAtlassianToken: string;
  }
  - OptionalaccountId?: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
  - contentId: string
    The ID of the content to remove the watcher from.
  - Optionalkey?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
  - Optionalusername?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
  - xAtlassianToken: string
    Note, you must add header when making a request, as this operation has XSRF protection.
Returns Promise<void>
Path
DELETE /wiki/rest/api/user/watch/content/{contentId} @scopes-current write:confluence-content @scopes-beta write:watcher:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-content-contentid-delete

removeLabelWatcher

removeLabelWatcher(params): 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).
Parameters
- params: {
      accountId?: string;
      key?: string;
      labelName: string;
      username?: string;
  }
  - OptionalaccountId?: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
  - Optionalkey?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
  - labelName: string
    The name of the label to remove the watcher from.
  - Optionalusername?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
Returns Promise<void>
Path
DELETE /wiki/rest/api/user/watch/label/{labelName} @scopes-current write:confluence-content @scopes-beta write:watcher:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-label-labelname-delete

removeSpaceWatch

removeSpaceWatch(params): 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).
Parameters
- params: {
      accountId?: string;
      key?: string;
      spaceKey: string;
      username?: string;
  }
  - OptionalaccountId?: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
  - Optionalkey?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
  - spaceKey: string
    The key of the space to remove the watcher from.
  - Optionalusername?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
Returns Promise<void>
Path
DELETE /wiki/rest/api/user/watch/space/{spaceKey} @scopes-current write:confluence-content @scopes-beta write:watcher:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-space-spacekey-delete

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class ContentWatchesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns ContentWatchesService

Methods

addContentWatcher

Parameters

OptionalaccountId?: string

contentId: string

Optionalkey?: string

Deprecated

Optionalusername?: string

Deprecated

Returns Promise<void>

Path

See

addLabelWatcher

Parameters

OptionalaccountId?: string

Optionalkey?: string

Deprecated

labelName: string

Optionalusername?: string

Deprecated

xAtlassianToken: string

Returns Promise<void>

Path

See

addSpaceWatcher

Parameters

OptionalaccountId?: string

Optionalkey?: string

Deprecated

spaceKey: string

Optionalusername?: string

Deprecated

xAtlassianToken: string

Returns Promise<void>

Path

See

getContentWatchStatus

Parameters

OptionalaccountId?: string

contentId: string

Optionalkey?: string

Deprecated

Optionalusername?: string

Deprecated

Returns Promise<UserWatch>

Path

See

getWatchersForSpace

Parameters

Optionallimit?: string

spaceKey: string

Optionalstart?: string

Returns Promise<SpaceWatchArray>

Path

See

getWatchesForPage

Parameters

id: string

Optionallimit?: number

Optionalstart?: number

Returns Promise<WatchArray>

Path

See

getWatchesForSpace

Parameters

id: string

Optionallimit?: number

Optionalstart?: number

Returns Promise<SpaceWatchArray>

`Optional`accountId?: string

`Optional`key?: string

`Optional`username?: string

`Optional`accountId?: string

`Optional`key?: string

`Optional`username?: string

`Optional`accountId?: string

`Optional`key?: string

`Optional`username?: string

`Optional`accountId?: string

`Optional`key?: string

`Optional`username?: string

`Optional`limit?: string

`Optional`start?: string

`Optional`limit?: number

`Optional`start?: number

`Optional`limit?: number

`Optional`start?: number

`Optional`accountId?: string

`Optional`key?: string

`Optional`username?: string

`Optional`accountId?: string

`Optional`key?: string

`Optional`username?: string

`Optional`accountId?: string

`Optional`key?: string

`Optional`username?: string

`Optional`accountId?: string

`Optional`key?: string

`Optional`username?: string

`Optional`accountId?: string

`Optional`key?: string

`Optional`username?: string

`Protected` `Static`initialize