com.liferay.portal.kernel.notifications

Interface ChannelHubManager

public interface ChannelHubManager

Author:

Edward Han

Method Summary

Modifier and Type	Method and Description
void	confirmDelivery(long companyId, long userId, Collection<String> notificationEventUuids)
void	confirmDelivery(long companyId, long userId, Collection<String> notificationEventUuids, boolean archive)
void	confirmDelivery(long companyId, long userId, String notificationEventUuid)
void	confirmDelivery(long companyId, long userId, String notificationEventUuid, boolean archive)
Channel	createChannel(long companyId, long userId)
ChannelHub	createChannelHub(long companyId)
void	deleteUserNotificiationEvent(long companyId, long userId, String notificationEventUuid)
void	deleteUserNotificiationEvents(long companyId, long userId, Collection<String> notificationEventUuids)
void	destroyChannel(long companyId, long userId)
void	destroyChannelHub(long companyId)
ChannelHub	fetchChannelHub(long companyId)
ChannelHub	fetchChannelHub(long companyId, boolean createIfAbsent)
List<NotificationEvent>	fetchNotificationEvents(long companyId, long userId, boolean flush)
void	flush()
void	flush(long companyId)
void	flush(long companyId, long userId, long timestamp)
Channel	getChannel(long companyId, long userId)
Channel	getChannel(long companyId, long userId, boolean createIfAbsent)
ChannelHub	getChannelHub(long companyId)
ChannelHub	getChannelHub(long companyId, boolean createIfAbsent)
List<NotificationEvent>	getNotificationEvents(long companyId, long userId)
List<NotificationEvent>	getNotificationEvents(long companyId, long userId, boolean flush)
Collection<Long>	getUserIds(long companyId)
void	registerChannelListener(long companyId, long userId, ChannelListener channelListener)
void	removeTransientNotificationEvents(long companyId, long userId, Collection<NotificationEvent> notificationEvents)
void	removeTransientNotificationEventsByUuid(long companyId, long userId, Collection<String> notificationEventUuids)
void	sendNotificationEvent(long companyId, long userId, NotificationEvent notificationEvent)
void	sendNotificationEvents(long companyId, long userId, Collection<NotificationEvent> notificationEvents)
void	storeNotificationEvent(long companyId, long userId, NotificationEvent notificationEvent)
void	unregisterChannelListener(long companyId, long userId, ChannelListener channelListener)

Method Detail

confirmDelivery

void confirmDelivery(long companyId,
                     long userId,
                     Collection<String> notificationEventUuids)
              throws ChannelException

Throws:

ChannelException

confirmDelivery

void confirmDelivery(long companyId,
                     long userId,
                     Collection<String> notificationEventUuids,
                     boolean archive)
              throws ChannelException

Throws:

ChannelException

confirmDelivery

void confirmDelivery(long companyId,
                     long userId,
                     String notificationEventUuid)
              throws ChannelException

Throws:

ChannelException

confirmDelivery

void confirmDelivery(long companyId,
                     long userId,
                     String notificationEventUuid,
                     boolean archive)
              throws ChannelException

Throws:

ChannelException

createChannel

Channel createChannel(long companyId,
                      long userId)
               throws ChannelException

Throws:

ChannelException

createChannelHub

ChannelHub createChannelHub(long companyId)
                     throws ChannelException

Throws:

ChannelException

deleteUserNotificiationEvent

void deleteUserNotificiationEvent(long companyId,
                                  long userId,
                                  String notificationEventUuid)
                           throws ChannelException

Throws:

ChannelException

deleteUserNotificiationEvents

void deleteUserNotificiationEvents(long companyId,
                                   long userId,
                                   Collection<String> notificationEventUuids)
                            throws ChannelException

Throws:

ChannelException

destroyChannel

void destroyChannel(long companyId,
                    long userId)
             throws ChannelException

Throws:

ChannelException

destroyChannelHub

void destroyChannelHub(long companyId)
                throws ChannelException

Throws:

ChannelException

fetchChannelHub

ChannelHub fetchChannelHub(long companyId)
                    throws ChannelException

Throws:

ChannelException

fetchChannelHub

ChannelHub fetchChannelHub(long companyId,
                           boolean createIfAbsent)
                    throws ChannelException

Throws:

ChannelException

fetchNotificationEvents

List<NotificationEvent> fetchNotificationEvents(long companyId,
                                                long userId,
                                                boolean flush)
                                         throws ChannelException

Throws:

ChannelException

flush

void flush()
    throws ChannelException

Throws:

ChannelException

flush

void flush(long companyId)
    throws ChannelException

Throws:

ChannelException

flush

void flush(long companyId,
           long userId,
           long timestamp)
    throws ChannelException

Throws:

ChannelException

getChannel

Channel getChannel(long companyId,
                   long userId)
            throws ChannelException

Throws:

ChannelException

getChannel

Channel getChannel(long companyId,
                   long userId,
                   boolean createIfAbsent)
            throws ChannelException

Throws:

ChannelException

getChannelHub

ChannelHub getChannelHub(long companyId)
                  throws ChannelException

Throws:

ChannelException

getChannelHub

ChannelHub getChannelHub(long companyId,
                         boolean createIfAbsent)
                  throws ChannelException

Throws:

ChannelException

getNotificationEvents

List<NotificationEvent> getNotificationEvents(long companyId,
                                              long userId)
                                       throws ChannelException

Throws:

ChannelException

getNotificationEvents

List<NotificationEvent> getNotificationEvents(long companyId,
                                              long userId,
                                              boolean flush)
                                       throws ChannelException

Throws:

ChannelException

getUserIds

Collection<Long> getUserIds(long companyId)
                     throws ChannelException

Throws:

ChannelException

registerChannelListener

void registerChannelListener(long companyId,
                             long userId,
                             ChannelListener channelListener)
                      throws ChannelException

Throws:

ChannelException

removeTransientNotificationEvents

void removeTransientNotificationEvents(long companyId,
                                       long userId,
                                       Collection<NotificationEvent> notificationEvents)
                                throws ChannelException

Throws:

ChannelException

removeTransientNotificationEventsByUuid

void removeTransientNotificationEventsByUuid(long companyId,
                                             long userId,
                                             Collection<String> notificationEventUuids)
                                      throws ChannelException

Throws:

ChannelException

sendNotificationEvent

void sendNotificationEvent(long companyId,
                           long userId,
                           NotificationEvent notificationEvent)
                    throws ChannelException

Throws:

ChannelException

sendNotificationEvents

void sendNotificationEvents(long companyId,
                            long userId,
                            Collection<NotificationEvent> notificationEvents)
                     throws ChannelException

Throws:

ChannelException

storeNotificationEvent

void storeNotificationEvent(long companyId,
                            long userId,
                            NotificationEvent notificationEvent)
                     throws ChannelException

Throws:

ChannelException

unregisterChannelListener

void unregisterChannelListener(long companyId,
                               long userId,
                               ChannelListener channelListener)
                        throws ChannelException

Throws:

ChannelException