com.adobe.cq.social.notifications.channel

Interface ChannelExtension

All Known Implementing Classes:

AbstractChannelExtensionService

public interface ChannelExtension

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ORDER
static String	PROP_EXTENSION_ORDER

Method Summary

Modifier and Type	Method and Description
void	afterDeliver(Notification notification, String userId, Session session, Map<String,Object> configuration) Callback method after the Channel.deliver(Notification) is performed.
void	beforeDeliver(Notification notification, String userId, Session session, Map<String,Object> configuration) Callback method before the Channel.deliver(Notification) is performed.
String	getName()
int	getOrder()

Field Detail

DEFAULT_ORDER

static final int DEFAULT_ORDER

See Also:

Constant Field Values

PROP_EXTENSION_ORDER

static final String PROP_EXTENSION_ORDER

See Also:

Constant Field Values

Method Detail

getOrder

int getOrder()

Returns:

the extension calling order

getName

String getName()

Returns:

the name of the extension.

beforeDeliver

void beforeDeliver(Notification notification,
                   String userId,
                   Session session,
                   Map<String,Object> configuration)
            throws ChannelException

Callback method before the Channel.deliver(Notification) is performed.

Parameters:

notification - the target Notification

userId - the user whom to be notified.

session - the session used by the channel.

configuration - the channel configuration.

Throws:

ChannelException - thrown if any one of the extensions throw an exception. This aborts the channel delivery operations.

afterDeliver

void afterDeliver(Notification notification,
                  String userId,
                  Session session,
                  Map<String,Object> configuration)
           throws ChannelException

Callback method after the Channel.deliver(Notification) is performed.

Parameters:

notification - the target Notification

userId - the user whom to be notified.

session - the session used by the channel.

configuration - the channel configuration.

Throws:

ChannelException - thrown if any one of the extensions throw an exception. This aborts the channel delivery operations.