Function: getWatchesForPage()

function getWatchesForPage(client, parameters): Promise<{
[key: string]: unknown;
  _links: {
   [key: string]: unknown;
     base?: string;
     byOperation?: string;
     collection?: string;
     context?: string;
     download?: string;
     editui?: string;
     edituiv2?: string;
     next?: string;
     prev?: string;
     self?: string;
     tinyui?: string;
     webui?: string;
  };
  limit: number;
  results: object[];
  size: number;
  start: number;
}>;

Defined in: src/v1/api/contentWatches.ts:31

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:

• Get content watch status for user
• Add content watch
• Remove content watch

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

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ id: string; limit?: number; start?: number; }	-
parameters.id	string	The ID of the content to be queried for its watches.
parameters.limit?	number	The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.
parameters.start?	number	The starting index of the returned watches.

Returns

Promise<{ [key: string]: unknown; _links: { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; }; limit: number; results: object[]; size: number; start: number; }>