com.liferay.portal.kernel.notifications

Interface ChannelHub

public interface ChannelHub

Author:

Edward Han

Method Summary

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

Method Detail

cleanUp

void cleanUp()
      throws ChannelException

Throws:

ChannelException

cleanUp

void cleanUp(long userId)
      throws ChannelException

Throws:

ChannelException

confirmDelivery

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

Throws:

ChannelException

confirmDelivery

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

Throws:

ChannelException

confirmDelivery

void confirmDelivery(long userId,
                     String notificationEventUuid)
              throws ChannelException

Throws:

ChannelException

confirmDelivery

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

Throws:

ChannelException

createChannel

Channel createChannel(long userId)
               throws ChannelException

Throws:

ChannelException

deleteUserNotificiationEvent

void deleteUserNotificiationEvent(long userId,
                                  String notificationEventUuid)
                           throws ChannelException

Throws:

ChannelException

deleteUserNotificiationEvents

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

Throws:

ChannelException

destroy

void destroy()
      throws ChannelException

Throws:

ChannelException

destroyChannel

Channel destroyChannel(long userId)
                throws ChannelException

Throws:

ChannelException

fetchChannel

Channel fetchChannel(long userId)
              throws ChannelException

Throws:

ChannelException

fetchChannel

Channel fetchChannel(long userId,
                     boolean createIfAbsent)
              throws ChannelException

Throws:

ChannelException

fetchNotificationEvents

List<NotificationEvent> fetchNotificationEvents(long userId)
                                         throws ChannelException

Throws:

ChannelException

fetchNotificationEvents

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

Throws:

ChannelException

flush

void flush()
    throws ChannelException

Throws:

ChannelException

flush

void flush(long userId)
    throws ChannelException

Throws:

ChannelException

flush

void flush(long userId,
           long timestamp)
    throws ChannelException

Throws:

ChannelException

getChannel

Channel getChannel(long userId)
            throws ChannelException

Throws:

ChannelException

getChannel

Channel getChannel(long userId,
                   boolean createIfAbsent)
            throws ChannelException

Throws:

ChannelException

getNotificationEvents

List<NotificationEvent> getNotificationEvents(long userId)
                                       throws ChannelException

Throws:

ChannelException

getNotificationEvents

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

Throws:

ChannelException

getUserIds

Collection<Long> getUserIds()

registerChannelListener

void registerChannelListener(long userId,
                             ChannelListener channelListener)
                      throws ChannelException

Throws:

ChannelException

removeTransientNotificationEvents

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

Throws:

ChannelException

removeTransientNotificationEventsByUuid

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

Throws:

ChannelException

sendNotificationEvent

void sendNotificationEvent(long userId,
                           NotificationEvent notificationEvent)
                    throws ChannelException

Throws:

ChannelException

sendNotificationEvents

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

Throws:

ChannelException

storeNotificationEvent

void storeNotificationEvent(long userId,
                            NotificationEvent notificationEvent)
                     throws ChannelException

Throws:

ChannelException

unregisterChannelListener

void unregisterChannelListener(long userId,
                               ChannelListener channelListener)
                        throws ChannelException

Throws:

ChannelException