com.gluonhq.charm.down.common

Class NotificationsService

java.lang.Object

com.gluonhq.charm.down.common.NotificationsService

public abstract class NotificationsService
extends java.lang.Object

The interface to the platform notification services.

Usage is as easy as:

     NotificationsService notificationsService = platform.getNotificationService();
     notificationsService.setRemoteNotificationHandler(myHandler);
     notificationsService.registerForNotificationTypes(NotificationType.Alert, NotificationType.Badge);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotificationsService.NotificationType The possible notification types you can register to.
static interface	NotificationsService.RemoteNotificationHandler The handler interface to process messages from the notifications system

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.EnumSet<NotificationsService.NotificationType>	reportedNotificationTypes collection of NotificationsService.NotificationTypes the user allowed to receive

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NotificationsService()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doRegisterForNotificationTypes(NotificationsService.NotificationType... notificationTypes)
abstract java.util.EnumSet<NotificationsService.NotificationType>	getCurrentNotificationTypes() return the collection of notification currently active.
java.util.EnumSet<NotificationsService.NotificationType>	getRegisteredNotificationTypes() return the collection of notifications you used with the registerForNotificationTypes(NotificationType...) call
NotificationsService.RemoteNotificationHandler	getRemoteNotificationHandler()
java.util.EnumSet<NotificationsService.NotificationType>	getReportedNotificationTypes() return the collection of notifications usable for the application reported by the notification system.
abstract boolean	isNotificationTypeSupported(NotificationsService.NotificationType notificationTypes) Check to see if the given NotificationsService.NotificationType is supported by the notification sytem
void	registerForNotificationTypes(NotificationsService.NotificationType... notificationTypes) actually to register for the given notification types.
void	setRemoteNotificationHandler(NotificationsService.RemoteNotificationHandler remoteNotificationHandler) setup your notification handler which will be called during the registration process or when a notification has been received.

Methods inherited from class java.lang.Object

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

Field Detail

reportedNotificationTypes

protected java.util.EnumSet<NotificationsService.NotificationType> reportedNotificationTypes

collection of NotificationsService.NotificationTypes the user allowed to receive

Constructor Detail

NotificationsService

protected NotificationsService()

Method Detail

getRemoteNotificationHandler

public NotificationsService.RemoteNotificationHandler getRemoteNotificationHandler()

setRemoteNotificationHandler

public void setRemoteNotificationHandler(NotificationsService.RemoteNotificationHandler remoteNotificationHandler)

setup your notification handler which will be called during the registration process or when a notification has been received.

Parameters:

remoteNotificationHandler - The notification handler

registerForNotificationTypes

public final void registerForNotificationTypes(NotificationsService.NotificationType... notificationTypes)

actually to register for the given notification types.

Parameters:

notificationTypes - Given notification types

getRegisteredNotificationTypes

public java.util.EnumSet<NotificationsService.NotificationType> getRegisteredNotificationTypes()

return the collection of notifications you used with the registerForNotificationTypes(NotificationType...) call

Returns:

EnumSet of notification types

getReportedNotificationTypes

public java.util.EnumSet<NotificationsService.NotificationType> getReportedNotificationTypes()

return the collection of notifications usable for the application reported by the notification system. This collection might differ to getRegisteredNotificationTypes() e.g. if the user did not permit all notifications you requested.

Returns:

EnumSet of notification types

isNotificationTypeSupported

public abstract boolean isNotificationTypeSupported(NotificationsService.NotificationType notificationTypes)

Check to see if the given NotificationsService.NotificationType is supported by the notification sytem

Parameters:

notificationTypes - notification type

Returns:

boolean

doRegisterForNotificationTypes

protected abstract void doRegisterForNotificationTypes(NotificationsService.NotificationType... notificationTypes)

getCurrentNotificationTypes

public abstract java.util.EnumSet<NotificationsService.NotificationType> getCurrentNotificationTypes()

return the collection of notification currently active. This collection might differ to getReportedNotificationTypes() e.g. if the user changed the permitted notification after program setup.

Returns:

EnumSet of notification types