net.bluemind.user.api

Interface IUserSubscription

All Known Subinterfaces:

IInternalUserSubscription

All Known Implementing Classes:

UserSubscriptionService

@Path(value="/users/{domainUid}/subscriptions")
public interface IUserSubscription

Method Summary

Modifier and Type	Method and Description
java.util.List<ContainerSubscriptionDescriptor>	listSubscriptions(java.lang.String subject, java.lang.String type) List subscribed containers
void	subscribe(java.lang.String subject, java.util.List<ContainerSubscription> subscriptions) Subscribe current User to a list of containers
java.util.List<java.lang.String>	subscribers(java.lang.String containerUid) Returns of list of subscribers to a given container
void	unsubscribe(java.lang.String subject, java.util.List<java.lang.String> containers) Unsubscribe current User from a list of containers

Method Detail

listSubscriptions

@GET
 @Path(value="{subject}")
java.util.List<ContainerSubscriptionDescriptor> listSubscriptions(@PathParam(value="subject")
                                                                                                 java.lang.String subject,
                                                                                                 @QueryParam(value="type")
                                                                                                 java.lang.String type)
                                                                                          throws ServerFault

List subscribed containers

Parameters:

subject -

type -

Returns:

Throws:

ServerFault

subscribers

@GET
 @Path(value="_subscribers/{containerUid}")
java.util.List<java.lang.String> subscribers(@PathParam(value="containerUid")
                                                                                              java.lang.String containerUid)

Returns of list of subscribers to a given container

Parameters:

containerUid -

Returns:

list of subscribers uid (as in BaseDirEntry.entryUid)

subscribe

@POST
 @Path(value="{subject}/_subscribe")
void subscribe(@PathParam(value="subject")
                                                          java.lang.String subject,
                                                          java.util.List<ContainerSubscription> subscriptions)
                                                   throws ServerFault

Subscribe current User to a list of containers

Parameters:

subject -

containers -

Throws:

ServerFault

unsubscribe

@POST
 @Path(value="{subject}/_unsubscribe")
void unsubscribe(@PathParam(value="subject")
                                                              java.lang.String subject,
                                                              java.util.List<java.lang.String> containers)
                                                       throws ServerFault

Unsubscribe current User from a list of containers

Parameters:

subject -

containers -

Throws:

ServerFault