com.caplin.datasource.notification

Class NotificationProvider

java.lang.Object

com.caplin.datasource.notification.NotificationProvider

public class NotificationProvider
extends java.lang.Object

If you want to manage notifications within your application you MUST create an instance of this class. This class manages notification subscription requests and provides your NotificationApplicationListener with callbacks when users log in and log out of the system.

User logins are delegated to your application as NotificationApplicationListener.notificationChannelOpened(NotificationChannel) calls. For details of how to send Notifications, see NotificationChannel.

Constructor Summary

Constructors

Constructor and Description
NotificationProvider(DataSource dataSource, NotificationConfiguration configuration, NotificationApplicationListener listener) Create a NotificationProvider registering your application.

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteNotification(java.lang.String user, java.lang.String notificationId)
java.lang.String	getVersion() Get the Notification API version.
void	publishNotification(java.lang.String user, Notification notification)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotificationProvider

public NotificationProvider(DataSource dataSource,
                    NotificationConfiguration configuration,
                    NotificationApplicationListener listener)

Create a NotificationProvider registering your application.

Parameters:

dataSource - An unstarted DataSource

configuration - NotificationConfiguration for your application

listener - Callback to your application on notification channel and notification item requests are received on this

Method Detail

getVersion

public java.lang.String getVersion()

Get the Notification API version.

Returns:

version Version of the Notification API in use

publishNotification

public void publishNotification(java.lang.String user,
                       Notification notification)

deleteNotification

public void deleteNotification(java.lang.String user,
                      java.lang.String notificationId)