com.adobe.cq.social.notifications.api

Interface NotificationManager

All Known Implementing Classes:

AbstractNotificationManager

public interface NotificationManager

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<Notification>	getNotifications(ResourceResolver resolver, UgcFilter filter, int startIndex, int size) Get notifications starting at the specified startIndex.
ActivityStream	getNotificationStream(ResourceResolver adminResolver, java.lang.String userId, boolean create) Get the notification stream for the specified userId.
long	getUnreadCount(ResourceResolver resolver, Constraint customConstraint, java.lang.String channelId) TODO: We probably want to move this API into ActivityStream Get the number of unread notification for the specified user and channel
int	getUnreadCountConfigured()
java.lang.Iterable<Resource>	getUnreadResource(ResourceResolver resolver, Constraint customConstraint, java.lang.String channelId)
boolean	isStreamExist(ResourceResolver resolver) Check if the stream exist for the owner of the specified resource resolver

Method Detail

isStreamExist

boolean isStreamExist(ResourceResolver resolver)

Check if the stream exist for the owner of the specified resource resolver

Parameters:

resolver - ResourceResolver

Returns:

boolean

getNotificationStream

ActivityStream getNotificationStream(ResourceResolver adminResolver,
                                     java.lang.String userId,
                                     boolean create)
                              throws ActivityException

Get the notification stream for the specified userId. If the stream does not exist and the create flag is set to true, the method create a notification stream; otherwise, it throws ActivityStreamExeption.

Parameters:

adminResolver - admin resolver

userId - the target user id

create - If the stream does not exist and the create flag is set to true, the method create a notification stream; otherwise, it throws ActivityExeption.

Returns:

ActivityStream

Throws:

ActivityException - Activity Exception on failure

getNotifications

java.lang.Iterable<Notification> getNotifications(ResourceResolver resolver,
                                                  UgcFilter filter,
                                                  int startIndex,
                                                  int size)

Get notifications starting at the specified startIndex.

Parameters:

resolver - owner resolver

filter - UgcFilter

startIndex - index to start from

size - size of the resultset

Returns:

Iterable

getUnreadCount

long getUnreadCount(ResourceResolver resolver,
                    Constraint customConstraint,
                    java.lang.String channelId)
             throws RepositoryException

TODO: We probably want to move this API into ActivityStream Get the number of unread notification for the specified user and channel

Parameters:

resolver - owner resolver

channelId - String

customConstraint - Constraint

Returns:

long

Throws:

RepositoryException - Repository Exception

getUnreadResource

java.lang.Iterable<Resource> getUnreadResource(ResourceResolver resolver,
                                               Constraint customConstraint,
                                               java.lang.String channelId)
                                        throws RepositoryException

Throws:

RepositoryException

getUnreadCountConfigured

int getUnreadCountConfigured()