Package io.github.primelib.confluence4j.rest.v1.client

Interface ConfluenceRestClientContentWatchesApi

@Generated("io.github.primelib.primecodegen") public interface ConfluenceRestClientContentWatchesApi
ConfluenceRestClientContentWatchesApi

  • Method Details

    • GetContentByIDNotificationChildCreatedV1

      WatchArray GetContentByIDNotificationChildCreatedV1(@NotNull @NotNull String id, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      GetContentByIDNotificationChildCreatedV1 Get watches for page 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](#api-user-watch-content-contentId-get) - [Add content watch](#api-user-watch-content-contentId-post) - [Remove content watch](#api-user-watch-content-contentId-delete) **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      id - The ID of the content to be queried for its watches.
      start - The starting index of the returned watches.
      limit - The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.

    • GetContentByIDNotificationCreatedV1

      SpaceWatchArray GetContentByIDNotificationCreatedV1(@NotNull @NotNull String id, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      GetContentByIDNotificationCreatedV1 Get watches for space 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: - [Get space watch status for user](#api-user-watch-space-spaceKey-get) - [Add space watch](#api-user-watch-space-spaceKey-post) - [Remove space watch](#api-user-watch-space-spaceKey-delete) **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      id - The ID of the content to be queried for its watches.
      start - The starting index of the returned watches.
      limit - The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.

    • GetSpaceBySpaceKeyWatchV1

      SpaceWatchArray GetSpaceBySpaceKeyWatchV1(@NotNull @NotNull String spaceKey, @Nullable @Nullable String start, @Nullable @Nullable String limit)
      GetSpaceBySpaceKeyWatchV1 Get space watchers Returns a list of watchers of a space
      Parameters:
      spaceKey - The key of the space to get watchers.
      start - The start point of the collection to return.
      limit - The limit of the number of items to return, this may be restricted by fixed system limits.

    • GetUserWatchContentByContentIDV1

      UserWatch GetUserWatchContentByContentIDV1(@NotNull @NotNull String contentId, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      GetUserWatchContentByContentIDV1 Get content watch status 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](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
      Parameters:
      contentId - The ID of the content to be queried for whether the specified user is watching it.
      key - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      username - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.

    • PostUserWatchContentByContentIDV1

      void PostUserWatchContentByContentIDV1(@NotNull @NotNull String contentId, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      PostUserWatchContentByContentIDV1 Add content watcher 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](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
      Parameters:
      contentId - The ID of the content to add the watcher to.
      key - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      username - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.

    • DeleteUserWatchContentByContentIDV1

      void DeleteUserWatchContentByContentIDV1(@NotNull @NotNull String xAtlassianToken, @NotNull @NotNull String contentId, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      DeleteUserWatchContentByContentIDV1 Remove content watcher 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](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
      Parameters:
      xAtlassianToken - Note, you must add header when making a request, as this operation has XSRF protection.
      contentId - The ID of the content to remove the watcher from.
      key - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      username - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.

    • GetUserWatchLabelByLabelNameV1

      UserWatch GetUserWatchLabelByLabelNameV1(@NotNull @NotNull String labelName, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      GetUserWatchLabelByLabelNameV1 Get label watch status 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](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
      Parameters:
      labelName - The name of the label to be queried for whether the specified user is watching it.
      key - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      username - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.

    • PostUserWatchLabelByLabelNameV1

      void PostUserWatchLabelByLabelNameV1(@NotNull @NotNull String xAtlassianToken, @NotNull @NotNull String labelName, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      PostUserWatchLabelByLabelNameV1 Add label watcher 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](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
      Parameters:
      xAtlassianToken - Note, you must add header when making a request, as this operation has XSRF protection.
      labelName - The name of the label to add the watcher to.
      key - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      username - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.

    • DeleteUserWatchLabelByLabelNameV1

      void DeleteUserWatchLabelByLabelNameV1(@NotNull @NotNull String labelName, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      DeleteUserWatchLabelByLabelNameV1 Remove label watcher 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](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
      Parameters:
      labelName - The name of the label to remove the watcher from.
      key - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      username - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.

    • GetUserWatchSpaceBySpaceKeyV1

      UserWatch GetUserWatchSpaceBySpaceKeyV1(@NotNull @NotNull String spaceKey, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      GetUserWatchSpaceBySpaceKeyV1 Get space watch status 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](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
      Parameters:
      spaceKey - The key of the space to be queried for whether the specified user is watching it.
      key - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      username - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.

    • PostUserWatchSpaceBySpaceKeyV1

      void PostUserWatchSpaceBySpaceKeyV1(@NotNull @NotNull String xAtlassianToken, @NotNull @NotNull String spaceKey, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      PostUserWatchSpaceBySpaceKeyV1 Add space watcher 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](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
      Parameters:
      xAtlassianToken - Note, you must add header when making a request, as this operation has XSRF protection.
      spaceKey - The key of the space to add the watcher to.
      key - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      username - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.

    • DeleteUserWatchSpaceBySpaceKeyV1

      void DeleteUserWatchSpaceBySpaceKeyV1(@NotNull @NotNull String spaceKey, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      DeleteUserWatchSpaceBySpaceKeyV1 Remove space watch 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](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
      Parameters:
      spaceKey - The key of the space to remove the watcher from.
      key - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      username - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.