com.liferay.portal.kernel.notifications
Interface Channel

All Known Implementing Classes:

BaseChannelImpl

public interface Channel

Method Summary

void	cleanUp()
Channel	clone(long companyId, long userId)
void	close()
void	confirmDelivery(Collection<String> notificationEventUuids)
void	confirmDelivery(Collection<String> notificationEventUuids, boolean archive)
void	confirmDelivery(String notificationEventUuid)
void	confirmDelivery(String notificationEventUuid, boolean archive)
void	deleteUserNotificiationEvent(String notificationEventUuid)
void	deleteUserNotificiationEvents(Collection<String> notificationEventUuids)
void	flush()
void	flush(long timestamp)
List<NotificationEvent>	getNotificationEvents()
List<NotificationEvent>	getNotificationEvents(boolean flush)
long	getUserId()
void	init()
void	registerChannelListener(ChannelListener channelListener)
void	removeTransientNotificationEvents(Collection<NotificationEvent> notificationEvents)
void	removeTransientNotificationEventsByUuid(Collection<String> notificationEventUuids)
void	sendNotificationEvent(NotificationEvent notificationEvent)
void	sendNotificationEvents(Collection<NotificationEvent> notificationEvents)
void	unregisterChannelListener(ChannelListener channelListener)

Method Detail

cleanUp

void cleanUp()
             throws ChannelException

Throws:

ChannelException

clone

Channel clone(long companyId,
              long userId)

close

void close()
           throws ChannelException

Throws:

ChannelException

confirmDelivery

void confirmDelivery(Collection<String> notificationEventUuids)
                     throws ChannelException

Throws:

ChannelException

confirmDelivery

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

Throws:

ChannelException

confirmDelivery

void confirmDelivery(String notificationEventUuid)
                     throws ChannelException

Throws:

ChannelException

confirmDelivery

void confirmDelivery(String notificationEventUuid,
                     boolean archive)
                     throws ChannelException

Throws:

ChannelException

deleteUserNotificiationEvent

void deleteUserNotificiationEvent(String notificationEventUuid)
                                  throws ChannelException

Throws:

ChannelException

deleteUserNotificiationEvents

void deleteUserNotificiationEvents(Collection<String> notificationEventUuids)
                                   throws ChannelException

Throws:

ChannelException

flush

void flush()
           throws ChannelException

Throws:

ChannelException

flush

void flush(long timestamp)
           throws ChannelException

Throws:

ChannelException

getNotificationEvents

List<NotificationEvent> getNotificationEvents()
                                              throws ChannelException

Throws:

ChannelException

getNotificationEvents

List<NotificationEvent> getNotificationEvents(boolean flush)
                                              throws ChannelException

Throws:

ChannelException

getUserId

long getUserId()

init

void init()
          throws ChannelException

Throws:

ChannelException

registerChannelListener

void registerChannelListener(ChannelListener channelListener)

removeTransientNotificationEvents

void removeTransientNotificationEvents(Collection<NotificationEvent> notificationEvents)

removeTransientNotificationEventsByUuid

void removeTransientNotificationEventsByUuid(Collection<String> notificationEventUuids)

sendNotificationEvent

void sendNotificationEvent(NotificationEvent notificationEvent)
                           throws ChannelException

Throws:

ChannelException

sendNotificationEvents

void sendNotificationEvents(Collection<NotificationEvent> notificationEvents)
                            throws ChannelException

Throws:

ChannelException

unregisterChannelListener

void unregisterChannelListener(ChannelListener channelListener)