public interface Channel
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CHANNEL_DESCRIPTION
Service registration property specifying the
getUserDescription() return value. |
Modifier and Type | Method and Description |
---|---|
boolean |
accept(java.lang.String resourceType)
Check whether the specified resource type is supported by this channel
|
void |
deliver(Notification notification,
java.lang.String userId)
Deliver the specified notification
|
java.util.Map<java.lang.String,java.lang.Object> |
getConfiguration()
Get the channel configuration
|
java.lang.String |
getId()
The id of this channel
|
java.lang.String |
getUserDescription()
Get the description of this channel
|
boolean |
isImmediate()
Check whether this channel to be executed immediately or not
|
void |
performAfterDeliver(Notification notification,
java.lang.String userId,
Session session,
java.util.Map<java.lang.String,java.lang.Object> configuration)
This method is being called after a channel performs its
deliver(com.adobe.cq.social.notifications.api.Notification, java.lang.String) operation. |
void |
performBeforeDeliver(Notification notification,
java.lang.String userId,
Session session,
java.util.Map<java.lang.String,java.lang.Object> configuration)
This method is being called before a channel performs its
deliver(com.adobe.cq.social.notifications.api.Notification, java.lang.String) operation. |
static final java.lang.String CHANNEL_DESCRIPTION
getUserDescription()
return value.
Channel service SHOULD be registered with this property. The value of the property is a string that describes the functionality of the channel.
java.lang.String getId()
boolean isImmediate()
java.lang.String getUserDescription()
void deliver(Notification notification, java.lang.String userId) throws ChannelException
notification
- NotificationuserId
- the user whom to be notified.ChannelException
- Channel Exceptionvoid performBeforeDeliver(Notification notification, java.lang.String userId, Session session, java.util.Map<java.lang.String,java.lang.Object> configuration) throws ChannelException
deliver(com.adobe.cq.social.notifications.api.Notification, java.lang.String)
operation. This is to allow
any channel extension to perform any delivery customization.notification
- the target Notification
userId
- the user whom to be notified.session
- the session that is being used to perform the operation.configuration
- the channel configuration.ChannelException
- thrown if any one of the operations extensions throws an exception. This aborts the
operations.void performAfterDeliver(Notification notification, java.lang.String userId, Session session, java.util.Map<java.lang.String,java.lang.Object> configuration) throws ChannelException
deliver(com.adobe.cq.social.notifications.api.Notification, java.lang.String)
operation. This is to allow
any channel extension to perform any delivery customization.notification
- the target Notification
userId
- the user whom to be notified.session
- the session that is being used to perform the operation.configuration
- the channel configuration.ChannelException
- thrown if any one of the operations extensions throws an exception. This aborts the
operations.boolean accept(java.lang.String resourceType)
resourceType
- Stringjava.util.Map<java.lang.String,java.lang.Object> getConfiguration()
Copyright © 2010 - 2020 Adobe. All Rights Reserved