com.atlassian.confluence.it.rpc
Class NotificationsRpc

java.lang.Object
  extended by com.atlassian.confluence.it.rpc.NotificationsRpc

public class NotificationsRpc
extends Object

Wraps the ConfluenceRpc object for notification-specific calls. All `watch*` calls are synced on event queue in order to avoid race condition when user starts watching space before first space page get created

Since:
4.2

Method Summary
 Collection<User> getWatchersForPage(AbstractPageEntity page)
          Gets all watchers of a page.
 boolean isWatchingPage(AbstractPageEntity page, User user)
          Check whether the given user is watching the given page.
 boolean isWatchingSpace(Space space, User user)
          Check whether the given user is watching the given space.
 boolean isWatchingSpaceForType(Space space, ContentTypeEnum contentType, User user)
          Check whether the given user is watching the given content type (e.g.
 void unwatchPageForUser(AbstractPageEntity page, User user)
          Removes a page watch for the specified user.
 void unwatchSpace(User user, Space space, ContentTypeEnum contentType)
           
 void watchNetwork(User user, boolean watchingNetwork)
          Sets Network watch emails for a user to enabled or disabled.
 void watchPage(AbstractPageEntity page)
          Watch a page as the current user.
 void watchPageForUser(AbstractPageEntity page, User user)
          Add a page watch for the specified user.
 void watchSiteBlogs(User user)
           
 void watchSpace(Space space)
          Watch a space as the current user.
 void watchSpace(User user, Space space)
          Watch all content in a space.
 void watchSpace(User user, Space space, ContentTypeEnum contentType)
          Watch all content of a certain type in a space.
 void watchSpaces(User user, Iterable<Space> spaces)
           
 void watchSpaces(User user, Iterable<Space> spaces, ContentTypeEnum contentType)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

watchSiteBlogs

public void watchSiteBlogs(User user)

watchSpace

public void watchSpace(User user,
                       Space space)
Watch all content in a space.

Parameters:
user - to watch content for
space - to watch content in

watchSpaces

public void watchSpaces(User user,
                        Iterable<Space> spaces)

watchSpace

public void watchSpace(User user,
                       Space space,
                       ContentTypeEnum contentType)
Watch all content of a certain type in a space.

Parameters:
user - to watch content for
space - to watch content in
contentType - type of content to watch (usually blogpost)

watchSpaces

public void watchSpaces(User user,
                        Iterable<Space> spaces,
                        ContentTypeEnum contentType)

watchSpace

public void watchSpace(Space space)
Watch a space as the current user.


watchPage

public void watchPage(AbstractPageEntity page)
Watch a page as the current user.


watchPageForUser

public void watchPageForUser(AbstractPageEntity page,
                             User user)
Add a page watch for the specified user.

Parameters:
page - the page whose watches will be checked, this must have its correct id set.

unwatchPageForUser

public void unwatchPageForUser(AbstractPageEntity page,
                               User user)
Removes a page watch for the specified user.

Parameters:
page - the page to stop watching
user - the user who no longer wants to watch

unwatchSpace

public void unwatchSpace(User user,
                         Space space,
                         ContentTypeEnum contentType)

isWatchingPage

public boolean isWatchingPage(AbstractPageEntity page,
                              User user)
Check whether the given user is watching the given page.

Parameters:
page - the page whose watches will be checked, this must have its correct id set.

isWatchingSpace

public boolean isWatchingSpace(Space space,
                               User user)
Check whether the given user is watching the given space.


isWatchingSpaceForType

public boolean isWatchingSpaceForType(Space space,
                                      ContentTypeEnum contentType,
                                      User user)
Check whether the given user is watching the given content type (e.g. blogs) in the space.


watchNetwork

public void watchNetwork(User user,
                         boolean watchingNetwork)
Sets Network watch emails for a user to enabled or disabled.

Parameters:
user - the user to set the watch state for
watchingNetwork - true if the user should watch their network, false if not

getWatchersForPage

public Collection<User> getWatchersForPage(AbstractPageEntity page)
Gets all watchers of a page.

Parameters:
page - page to get watchers from


Copyright © 2003–2015 Atlassian. All rights reserved.