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) Deprecated. since 7.0.1. Use isWatchingContentCompletionStage(UserKey, ContentId) instead.
CompletionStage<Boolean>	isWatchingContentCompletionStage(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) Deprecated. since 7.0.1. Use isWatchingSpaceCompletionStage(UserKey, String, ContentType) instead.
com.atlassian.util.concurrent.Promise<Boolean>	isWatchingSpace(com.atlassian.sal.api.user.UserKey userKey, String spaceKey, ContentType contentType) Deprecated. since 7.0.1. Use isWatchingSpaceCompletionStage(UserKey, String, ContentType) instead.
CompletionStage<Boolean>	isWatchingSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey, String spaceKey)
CompletionStage<Boolean>	isWatchingSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey, String spaceKey, ContentType contentType)
com.atlassian.util.concurrent.Promise<Void>	unwatchContent(com.atlassian.sal.api.user.UserKey userKey, ContentId contentId) Deprecated. since 7.0.1. Use unwatchContentCompletionStage(UserKey, ContentId) instead.
CompletionStage<Void>	unwatchContentCompletionStage(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) Deprecated. since 7.0.1. Use unwatchSpaceCompletionStage(UserKey, String, List) instead.
com.atlassian.util.concurrent.Promise<Void>	unwatchSpace(com.atlassian.sal.api.user.UserKey userKey, String spaceKey, List<ContentType> contentTypes) Deprecated. since 7.0.1. Use unwatchSpaceCompletionStage(UserKey, String, List) instead.
CompletionStage<Void>	unwatchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey, String spaceKey) Remove a watch to the given space
CompletionStage<Void>	unwatchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey, String spaceKey, List<ContentType> contentTypes)
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) Deprecated. since 7.0.1. Use watchContentCompletionStage(UserKey, ContentId) instead.
CompletionStage<ContentWatch>	watchContentCompletionStage(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) Deprecated. since 7.0.1. Use watchSpaceCompletionStage(UserKey, String, List) instead.
com.atlassian.util.concurrent.Promise<SpaceWatch>	watchSpace(com.atlassian.sal.api.user.UserKey userKey, String spaceKey, List<ContentType> contentTypes) Deprecated. since 7.0.1. Use watchSpaceCompletionStage(UserKey, String, List) instead.
CompletionStage<SpaceWatch>	watchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey, String spaceKey) Create a watch to the given space
CompletionStage<SpaceWatch>	watchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey, String spaceKey, List<ContentType> contentTypes) Remove a watch to the blog posts in a given space

Method Detail

watchSpace

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

Deprecated. since 7.0.1. Use watchSpaceCompletionStage(UserKey, String, List) instead.

Remove a watch to the blog posts in a 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

contentTypes - the content types in the space to remove the watch for

Since:

6.8.0

unwatchSpace

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

Deprecated. since 7.0.1. Use unwatchSpaceCompletionStage(UserKey, String, List) instead.

Parameters:

userKey - the watcher

spaceKey - the key of the space to check

contentTypes - the content types in the space to check if watching is given

Returns:

whether the user is watching the given space or not

Since:

6.8.0

watchSpaceCompletionStage

CompletionStage<SpaceWatch> watchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey,
                                                      String spaceKey,
                                                      List<ContentType> contentTypes)

Remove a watch to the blog posts in a 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

contentTypes - the content types in the space to remove the watch for

Since:

7.0.1

unwatchSpaceCompletionStage

CompletionStage<Void> unwatchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey,
                                                  String spaceKey,
                                                  List<ContentType> contentTypes)

Parameters:

userKey - the watcher

spaceKey - the key of the space to check

contentTypes - the content types in the space to check if watching is given

Returns:

whether the user is watching the given space or not

Since:

7.0.1

isWatchingSpace

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

Deprecated. since 7.0.1. Use isWatchingSpaceCompletionStage(UserKey, String, ContentType) instead.

Parameters:

userKey - the watcher

spaceKey - the key of the space to check

contentType - the content type

Returns:

whether the user is watching the specific content type in the given space or not

Since:

6.8.0

isWatchingSpaceCompletionStage

CompletionStage<Boolean> isWatchingSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey,
                                                        String spaceKey,
                                                        ContentType contentType)

Parameters:

userKey - the watcher

spaceKey - the key of the space to check

contentType - the content type

Returns:

whether the user is watching the specific content type in the given space or not

Since:

7.0.1

watchSpace

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

Deprecated. since 7.0.1. Use watchSpaceCompletionStage(UserKey, String, List) instead.

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

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

Deprecated. since 7.0.1. Use unwatchSpaceCompletionStage(UserKey, String, List) instead.

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

watchSpaceCompletionStage

CompletionStage<SpaceWatch> watchSpaceCompletionStage(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

Since:

7.0.1

unwatchSpaceCompletionStage

CompletionStage<Void> unwatchSpaceCompletionStage(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

Since:

7.0.1

isWatchingSpace

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

Deprecated. since 7.0.1. Use isWatchingSpaceCompletionStage(UserKey, String, ContentType) instead.

Parameters:

userKey - the watcher

spaceKey - the key of the space to check

Returns:

whether the user is watching the given space or not

isWatchingSpaceCompletionStage

CompletionStage<Boolean> isWatchingSpaceCompletionStage(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

Since:

7.0.1

watchContent

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

Deprecated. since 7.0.1. Use watchContentCompletionStage(UserKey, ContentId) instead.

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

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

Deprecated. since 7.0.1. Use unwatchContentCompletionStage(UserKey, ContentId) instead.

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

watchContentCompletionStage

CompletionStage<ContentWatch> watchContentCompletionStage(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

Since:

7.0.1

unwatchContentCompletionStage

CompletionStage<Void> unwatchContentCompletionStage(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

Since:

7.0.1

isWatchingContent

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

Deprecated. since 7.0.1. Use isWatchingContentCompletionStage(UserKey, ContentId) instead.

Parameters:

userKey - the watcher

content - the content to check

Returns:

whether the user is watching the given content or not

isWatchingContentCompletionStage

CompletionStage<Boolean> isWatchingContentCompletionStage(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

Since:

7.0.1

validator

WatchService.Validator validator()

Get the validator of the WatchService.

Returns:

a Validator that can be used to validate service requests.