The notification API is used as a means for transferring notifications between interested parties. In most cases a notification provider maintains a list of messages, and each message is associated with an ever increasing 'epoch number.' A client can retrieve the latest epoch number from a provider and then poll for changes since that epoch - all updates since that point can be returned.

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
List<RaptureNotificationConfig> retVal = notificationApi.getNotificationManagerConfigs();

retVal = baseAPI.doNotification_GetNotificationManagerConfigs();

Entitlement: /admin/notification

This method retrieves the notification providers in use at this Rapture system.

This function takes no parameters.

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
List<RaptureFolderInfo> retVal = notificationApi.listNotificationsByUriPrefix(uriPrefix);

retVal = baseAPI.doNotification_ListNotificationsByUriPrefix(uriPrefix);

Entitlement: /user/get

Returns a list of full display names of the paths below this one. Ideally optimized depending on the repo.

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
List<RaptureNotificationConfig> retVal = notificationApi.findNotificationManagerConfigsByPurpose(purpose);

retVal = baseAPI.doNotification_FindNotificationManagerConfigsByPurpose(purpose);

Entitlement: /admin/notification

Notification providers have an associated purpose - this method returns only those providers that match the given purpose.

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
RaptureNotificationConfig retVal = notificationApi.createNotificationManager(notificationManagerUri, config, purpose);

retVal = baseAPI.doNotification_CreateNotificationManager(notificationManagerUri, config, purpose);

Entitlement: /admin/notification

This method creates a definition of a notification provider.

Config info for the main object in the Notification API.

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
boolean retVal = notificationApi.notificationManagerExists(notificationManagerUri);

retVal = baseAPI.doNotification_NotificationManagerExists(notificationManagerUri);

Entitlement: /admin/notification

Indicates whether a notification provider with notificationName was found.

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
RaptureNotificationConfig retVal = notificationApi.getNotificationManagerConfig(notificationManagerUri);

retVal = baseAPI.doNotification_GetNotificationManagerConfig(notificationManagerUri);

Entitlement: /admin/notification

This method returns the low level config for a given notification provider.

Config info for the main object in the Notification API.

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
void retVal = notificationApi.deleteNotificationManager(notificationManagerUri);

retVal = baseAPI.doNotification_DeleteNotificationManager(notificationManagerUri);

Entitlement: /admin/notification

This method removes a notification provider and all its content.

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
Long retVal = notificationApi.getLatestNotificationEpoch(notificationManagerUri);

retVal = baseAPI.doNotification_GetLatestNotificationEpoch(notificationManagerUri);

Entitlement: /user/notification

This method retrieves the current epoch number for a given notification point.

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
String retVal = notificationApi.publishNotification(notificationManagerUri, referenceId, content, contentType);

retVal = baseAPI.doNotification_PublishNotification(notificationManagerUri, referenceId, content, contentType);

Entitlement: /user/notification

This method pushes a notification to a provider.

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
NotificationResult retVal = notificationApi.findNotificationsAfterEpoch(notificationManagerUri, epoch);

retVal = baseAPI.doNotification_FindNotificationsAfterEpoch(notificationManagerUri, epoch);

Entitlement: /admin/notification

This method returns the changes seen on a notification since an epoch. A client would then update its latest epoch by using the value in the notification result.

The object returned by a notification

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
NotificationInfo retVal = notificationApi.getNotification(notificationUri, id);

retVal = baseAPI.doNotification_GetNotification(notificationUri, id);

Entitlement: /admin/notification

This method returns a notification message given its id.

Contains all relevant data for a notification.