pl.edu.icm.unity.engine.api.notification

Interface NotificationProducer

public interface NotificationProducer

Notification sending facility. Should be used internally, i.e. the users shouldn't have the possibility to invoke operations of this interface directly.

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method and Description
Future<NotificationStatus>	sendNotification(pl.edu.icm.unity.types.basic.EntityParam recipient, String channelName, String templateId, Map<String,String> params, String locale, String preferredAddress) Sends a message which is resolved from a given template with parameters.
Future<NotificationStatus>	sendNotification(String recipientAddress, String channelName, String templateId, Map<String,String> params, String locale) Sends a message which is resolved from a given template with parameters.
void	sendNotificationToGroup(String group, String channelName, String templateId, Map<String,String> params, String locale) Sends a message which is resolved from a given template with parameters.

Method Detail

sendNotification

Future<NotificationStatus> sendNotification(pl.edu.icm.unity.types.basic.EntityParam recipient,
                                            String channelName,
                                            String templateId,
                                            Map<String,String> params,
                                            String locale,
                                            String preferredAddress)
                                     throws pl.edu.icm.unity.exceptions.EngineException

Sends a message which is resolved from a given template with parameters.

Parameters:

recipient -

channelName -

templateId -

params -

locale - can be null. In such case the server's default locale will be used

preferredAddress - can be null. If not null then this address will be used if can be found among all valid addresses of entity.

Returns:

Throws:

pl.edu.icm.unity.exceptions.EngineException

sendNotification

Future<NotificationStatus> sendNotification(String recipientAddress,
                                            String channelName,
                                            String templateId,
                                            Map<String,String> params,
                                            String locale)
                                     throws pl.edu.icm.unity.exceptions.EngineException

Sends a message which is resolved from a given template with parameters.

Parameters:

recipientAddress - actual address of the recipient, as email address.

channelName -

templateId -

params -

locale - can be null. In such case the server's default locale will be used

Returns:

Throws:

pl.edu.icm.unity.exceptions.EngineException

sendNotificationToGroup

void sendNotificationToGroup(String group,
                             String channelName,
                             String templateId,
                             Map<String,String> params,
                             String locale)
                      throws pl.edu.icm.unity.exceptions.EngineException

Sends a message which is resolved from a given template with parameters. This version sends a message to all entities which are members of a given group and have channel's address defined in this group.

Parameters:

group -

channelName -

templateId -

params -

locale - can be null. In such case the server's default locale will be used

Throws:

pl.edu.icm.unity.exceptions.EngineException