com.atlassian.confluence.rest.client

Interface RemoteWatchService

All Known Implementing Classes:

RemoteWatchServiceImpl

@ExperimentalApi
public interface RemoteWatchService

WatchService implementation that communicates with Confluence remotely using the Confluence REST api.

Provides future returning equivalents for the methods in WatchService.

Method Summary

Modifier and Type	Method and Description
com.atlassian.util.concurrent.Promise<Boolean>	isWatchingContent(com.atlassian.sal.api.user.UserKey userKey, ContentId content)
com.atlassian.util.concurrent.Promise<Boolean>	isWatchingSpace(com.atlassian.sal.api.user.UserKey userKey, String spaceKey)
com.atlassian.util.concurrent.Promise<Void>	unwatchContent(com.atlassian.sal.api.user.UserKey userKey, ContentId contentId) Remove a watch to the given content
com.atlassian.util.concurrent.Promise<Void>	unwatchSpace(com.atlassian.sal.api.user.UserKey userKey, String spaceKey) Remove a watch to the given space
WatchService.Validator	validator() Get the validator of the WatchService.
com.atlassian.util.concurrent.Promise<ContentWatch>	watchContent(com.atlassian.sal.api.user.UserKey userKey, ContentId contentId) Create a watch to the given content
com.atlassian.util.concurrent.Promise<SpaceWatch>	watchSpace(com.atlassian.sal.api.user.UserKey userKey, String spaceKey) Create a watch to the given space

Method Detail

watchSpace

com.atlassian.util.concurrent.Promise<SpaceWatch> watchSpace(com.atlassian.sal.api.user.UserKey userKey,
                                                             String spaceKey)

Create a watch to the given space

Parameters:

userKey - the key of the user to add as a watcher

spaceKey - the key of the space to add the watch for

unwatchSpace

com.atlassian.util.concurrent.Promise<Void> unwatchSpace(com.atlassian.sal.api.user.UserKey userKey,
                                                         String spaceKey)

Remove a watch to the given space

Parameters:

userKey - the key of the user to add as a watcher

spaceKey - the key of the space to remove the watch for

isWatchingSpace

com.atlassian.util.concurrent.Promise<Boolean> isWatchingSpace(com.atlassian.sal.api.user.UserKey userKey,
                                                               String spaceKey)

Parameters:

userKey - the watcher

spaceKey - the key of the space to check

Returns:

whether the user is watching the given space or not

watchContent

com.atlassian.util.concurrent.Promise<ContentWatch> watchContent(com.atlassian.sal.api.user.UserKey userKey,
                                                                 ContentId contentId)

Create a watch to the given content

Parameters:

userKey - the key of the user to add as a watcher

contentId - the id of the content to add the watch for

unwatchContent

com.atlassian.util.concurrent.Promise<Void> unwatchContent(com.atlassian.sal.api.user.UserKey userKey,
                                                           ContentId contentId)

Remove a watch to the given content

Parameters:

userKey - the key of the user to add as a watcher

contentId - the id of the content to remove the watch for

isWatchingContent

com.atlassian.util.concurrent.Promise<Boolean> isWatchingContent(com.atlassian.sal.api.user.UserKey userKey,
                                                                 ContentId content)

Parameters:

userKey - the watcher

content - the content to check

Returns:

whether the user is watching the given content or not

validator

WatchService.Validator validator()

Get the validator of the WatchService.

Returns:

a Validator that can be used to validate service requests.