Package com.atlassian.confluence.plugins.restapi.resources

Class UserWatchResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.UserWatchResource

@Consumes("application/json")
@Produces("application/json")
@Path("/user/watch")
public class UserWatchResource
extends Object

A REST resource for manipulating watchers for Spaces, pieces of Content and Labels.

Constructor Summary

Constructors

Constructor	Description
UserWatchResource(WatchService watchService, PersonService personService)

Method Summary

Modifier and Type	Method	Description
ContentWatch	addContentWatcher(com.atlassian.sal.api.user.UserKey key, String username, ContentId contentId)
SpaceWatch	addSpaceWatch(com.atlassian.sal.api.user.UserKey key, String username, List<ContentType> contentTypes, String spaceKey)
javax.ws.rs.core.Response	isWatchingContent(com.atlassian.sal.api.user.UserKey key, String username, ContentId contentId)
javax.ws.rs.core.Response	isWatchingSpace(com.atlassian.sal.api.user.UserKey key, String username, ContentType contentType, String spaceKey)
javax.ws.rs.core.Response	removeContentWatcher(com.atlassian.sal.api.user.UserKey key, String username, ContentId contentId)
javax.ws.rs.core.Response	removeSpaceWatch(com.atlassian.sal.api.user.UserKey key, String username, List<ContentType> contentTypes, String spaceKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserWatchResource

@Inject
public UserWatchResource(WatchService watchService,
 PersonService personService)

Method Details

addSpaceWatch

@PublicApi
@POST
@Path("/space/{spaceKey}")
public SpaceWatch addSpaceWatch(@QueryParam("key")
 com.atlassian.sal.api.user.UserKey key,
 @QueryParam("username")
 String username,
 @QueryParam("contentType")
 List<ContentType> contentTypes,
 @PathParam("spaceKey")
 String spaceKey)
                         throws ServiceException

Throws:

ServiceException

removeSpaceWatch

@PublicApi
@DELETE
@Path("/space/{spaceKey}")
public javax.ws.rs.core.Response removeSpaceWatch(@QueryParam("key")
 com.atlassian.sal.api.user.UserKey key,
 @QueryParam("username")
 String username,
 @QueryParam("contentType")
 List<ContentType> contentTypes,
 @PathParam("spaceKey")
 String spaceKey)
                                           throws ServiceException

Throws:

ServiceException

isWatchingSpace

@PublicApi
@GET
@Path("/space/{spaceKey}")
public javax.ws.rs.core.Response isWatchingSpace(@QueryParam("key")
 com.atlassian.sal.api.user.UserKey key,
 @QueryParam("username")
 String username,
 @QueryParam("contentType")
 ContentType contentType,
 @PathParam("spaceKey")
 String spaceKey)
                                          throws ServiceException

Throws:

ServiceException

addContentWatcher

@PublicApi
@POST
@Path("/content/{contentId}")
public ContentWatch addContentWatcher(@QueryParam("key")
 com.atlassian.sal.api.user.UserKey key,
 @QueryParam("username")
 String username,
 @PathParam("contentId")
 ContentId contentId)
                               throws ServiceException

Throws:

ServiceException

removeContentWatcher

@PublicApi
@DELETE
@Path("/content/{contentId}")
public javax.ws.rs.core.Response removeContentWatcher(@QueryParam("key")
 com.atlassian.sal.api.user.UserKey key,
 @QueryParam("username")
 String username,
 @PathParam("contentId")
 ContentId contentId)
                                               throws ServiceException

Throws:

ServiceException

isWatchingContent

@PublicApi
@GET
@Path("/content/{contentId}")
public javax.ws.rs.core.Response isWatchingContent(@QueryParam("key")
 com.atlassian.sal.api.user.UserKey key,
 @QueryParam("username")
 String username,
 @PathParam("contentId")
 ContentId contentId)
                                            throws ServiceException

Throws:

ServiceException