C D F G I N O P R S T U
All Classes All Packages

C

closeChannel() - Method in interface com.caplin.datasource.notification.NotificationChannel

Closes the channel.

com.caplin.datasource.notification - package com.caplin.datasource.notification

This package contains the public elements of the Notification API.

D

deleteNotification(String, String) - Method in class com.caplin.datasource.notification.NotificationProvider

F

fields - Variable in class com.caplin.datasource.notification.Notification

G

getChannelNamespace() - Method in class com.caplin.datasource.notification.NotificationConfiguration

Gets the channel namespace.

getContainerThrottleMillis() - Method in class com.caplin.datasource.notification.NotificationConfiguration

Get the current millisecond delay used for container throttling

getField(String) - Method in class com.caplin.datasource.notification.Notification

getFields() - Method in class com.caplin.datasource.notification.Notification

getItemNamespace() - Method in class com.caplin.datasource.notification.NotificationConfiguration

Gets the item namespace.

getSourceName() - Method in class com.caplin.datasource.notification.NotificationConfiguration

Gets the notification source name.

getSubject() - Method in interface com.caplin.datasource.notification.NotificationChannel

Returns the subject for the channel.

getUniqueId() - Method in class com.caplin.datasource.notification.Notification

getUsername() - Method in interface com.caplin.datasource.notification.NotificationChannel

Returns the username for the channel

getVersion() - Method in class com.caplin.datasource.notification.NotificationProvider

Get the Notification API version.

I

internalConfiguration - Variable in class com.caplin.datasource.notification.NotificationConfiguration

isNotificationUsingImageFlag() - Method in class com.caplin.datasource.notification.NotificationConfiguration

Returns true if image flags are set to true on each Notification record for its initial message, otherwise false.

N

Notification - Class in com.caplin.datasource.notification

Notification represents a single notification to be sent to a client.

Notification(String) - Constructor for class com.caplin.datasource.notification.Notification

NotificationApplicationListener - Interface in com.caplin.datasource.notification

You must implement this interface.

NotificationChannel - Interface in com.caplin.datasource.notification

The NotificationChannel is a notification communication channel associated with a particular user.

notificationChannelClosed(NotificationChannel) - Method in interface com.caplin.datasource.notification.NotificationApplicationListener

Callback invoked when a discard for a notification channel is received.

NotificationChannelListener - Interface in com.caplin.datasource.notification

You should implement (and register) the NotificationChannelListener if you want to receive a callback when a user has dismissed a notification from their screen.

notificationChannelOpened(NotificationChannel) - Method in interface com.caplin.datasource.notification.NotificationApplicationListener

Callback invoked when a request for the notification channel is received.

NotificationConfiguration - Class in com.caplin.datasource.notification

Configuration for the Notifications Provider.

NotificationConfiguration(String) - Constructor for class com.caplin.datasource.notification.NotificationConfiguration

Instantiates a new NotificationConfiguration.

NotificationProvider - Class in com.caplin.datasource.notification

If you want to manage notifications within your application you MUST create an instance of this class.

NotificationProvider(DataSource, NotificationConfiguration, NotificationApplicationListener) - Constructor for class com.caplin.datasource.notification.NotificationProvider

Create a NotificationProvider registering your application.

O

onNotificationAction(NotificationChannel, String, String) - Method in interface com.caplin.datasource.notification.NotificationChannelListener

Called when a contrib comes in for a Notification serviced by this provider.

onNotificationRequest(NotificationChannel, String) - Method in interface com.caplin.datasource.notification.NotificationChannelListener

Called when a previously unsubmitted notification in a channel is requested.

P

publishNotification(String, Notification) - Method in class com.caplin.datasource.notification.NotificationProvider

R

removeNotification(String) - Method in interface com.caplin.datasource.notification.NotificationChannel

Removes the Notification from the internal cache and sends a container remove so that this notification is no longer requested when the channel is subscribed to.

removeNotifications(List<String>) - Method in interface com.caplin.datasource.notification.NotificationChannel

Removes Notifications from the internal cache and sends a container remove so that these notifications are no longer requested when the channel is subscribed to.

S

sendEmptyNotificationContainer() - Method in interface com.caplin.datasource.notification.NotificationChannel

Sends an empty container on the channel.

sendNotification(Notification) - Method in interface com.caplin.datasource.notification.NotificationChannel

Adds the Notification to the internal cache and sends a container add so that this notification is requested when the channel is subscribed to.

sendNotificationContainerStatusOk() - Method in interface com.caplin.datasource.notification.NotificationChannel

Sends a status ok on the channel.

sendNotificationContainerStatusStale() - Method in interface com.caplin.datasource.notification.NotificationChannel

Sends a status stale on the channel.

sendNotificationNotFound(String) - Method in interface com.caplin.datasource.notification.NotificationChannel

Sends a not found for a Notification.

sendNotifications(List<Notification>) - Method in interface com.caplin.datasource.notification.NotificationChannel

Adds Notifications to the internal cache and sends a container add so that these items are requested when the channel is subscribed to.

sendNotificationStatusOk(String) - Method in interface com.caplin.datasource.notification.NotificationChannel

Send status ok for a Notification.

sendNotificationStatusStale(String) - Method in interface com.caplin.datasource.notification.NotificationChannel

Send status stale for a Notification.

setContainerThrottleMillis(int) - Method in class com.caplin.datasource.notification.NotificationConfiguration

Specify the millisecond delay used to throttle subsequent operations to a single container.

setField(String, String) - Method in class com.caplin.datasource.notification.Notification

setFields(Map<String, String>) - Method in class com.caplin.datasource.notification.Notification

setNotificationChannelListener(NotificationChannelListener) - Method in interface com.caplin.datasource.notification.NotificationChannel

Your application SHOULD set a NotificationChannelListener on the channel.

setNotificationUsingImageFlag(boolean) - Method in class com.caplin.datasource.notification.NotificationConfiguration

Set the Notification records' image flags to be set to true on publishing initial message.

T

toRecordItem(String, String) - Method in class com.caplin.datasource.notification.Notification

toString() - Method in class com.caplin.datasource.notification.Notification

toString() - Method in class com.caplin.datasource.notification.NotificationConfiguration

U

uniqueId - Variable in class com.caplin.datasource.notification.Notification

C D F G I N O P R S T U
All Classes All Packages