ContentWatchesApi class

This document describes the REST API and resources provided by Confluence. The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.Confluence's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE. Because the REST API is based on open standards, you can use any web development language to access the API.

Constructors

ContentWatchesApi(ApiClient _client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addContentWatcher({required String contentId, String? key, String? username, String? accountId}) → Future<void>

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

addLabelWatcher({required String xAtlassianToken, required String labelName, String? key, String? username, String? accountId}) → Future<void>

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

addSpaceWatcher({required String xAtlassianToken, required String spaceKey, String? key, String? username, String? accountId}) → Future<void>

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

getContentWatchStatus({required String contentId, String? key, String? username, String? accountId}) → Future<UserWatch>

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

getWatchersForSpace({required String spaceKey, String? start, String? limit}) → Future<SpaceWatchArray>

Returns a list of watchers of a space

getWatchesForPage({required String id, int? start, int? limit}) → Future<WatchArray>

Returns the watches for a page. A user that watches a page will receive receive notifications when the page is updated.

getWatchesForSpace({required String id, int? start, int? limit}) → Future<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.

isWatchingLabel({required String labelName, String? key, String? username, String? accountId}) → Future<UserWatch>

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

isWatchingSpace({required String spaceKey, String? key, String? username, String? accountId}) → Future<UserWatch>

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeContentWatcher({required String xAtlassianToken, required String contentId, String? key, String? username, String? accountId}) → Future<void>

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

removeLabelWatcher({required String labelName, String? key, String? username, String? accountId}) → Future<void>

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

removeSpaceWatch({required String spaceKey, String? key, String? username, String? accountId}) → Future<void>

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

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited