Liferay 6.2.0

com.liferay.portal.kernel.notifications
Interface ChannelHub

All Known Implementing Classes:
ChannelHubImpl

public interface ChannelHub


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

Method Detail

cleanUp

void cleanUp()
             throws ChannelException
Throws:
ChannelException

cleanUp

void cleanUp(long userId)
             throws ChannelException
Throws:
ChannelException

clone

ChannelHub clone(long companyId)

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

Liferay 6.2.0