com.lightstreamer.interfaces.metadata

Class MpnSubscriptionInfo.MpnApnsSubscriptionInfo

java.lang.Object

com.lightstreamer.interfaces.metadata.MpnSubscriptionInfo

com.lightstreamer.interfaces.metadata.MpnSubscriptionInfo.MpnApnsSubscriptionInfo

Enclosing class:

MpnSubscriptionInfo

public static class MpnSubscriptionInfo.MpnApnsSubscriptionInfo
extends MpnSubscriptionInfo

Concrete subclass of MpnSubscriptionInfo for APNS platform type. Collects all the details of a push notifications specification for Apple's APNS.

Edition Note:

Push Notifications are not supported in Moderato edition.

Nested Class Summary

Nested classes/interfaces inherited from class com.lightstreamer.interfaces.metadata.MpnSubscriptionInfo

MpnSubscriptionInfo.MpnApnsSubscriptionInfo, MpnSubscriptionInfo.MpnGcmSubscriptionInfo

Constructor Summary

Constructors

Constructor and Description

MpnApnsSubscriptionInfo(MpnDeviceInfo device, java.lang.String sound, java.lang.String badge, java.lang.String contentAvailable, java.lang.String localizedActionKey, java.lang.String category, java.lang.String launchImage, java.lang.String format, java.lang.String localizedFormatKey, java.util.List arguments, java.util.Map customData, java.lang.String trigger) Used by Lightstreamer to create an MpnApnsSubscriptionInfo instance, collecting all the details of a push notifications specification for Apple's APNS.

Method Summary

Modifier and Type	Method and Description
java.util.List	getArguments() Returns the list of optional arguments to be used with a localized format key.
java.lang.String	getBadge() Returns the optional value for the icon badge when a push notification is delivered.
java.lang.String	getCategory() Returns the optional category of the mobile push notification, to be used by the receiving application to present appropriate action buttons.
java.lang.String	getContentAvailable() Returns the optional flag to signal the availability of new content to a Newsstand application through the delivery of a push notification.
java.util.Map	getCustomData() Returns the map of optional custom key-value pairs to be added to the push notification.
java.lang.String	getFormat() Returns the format for the push notification text when it is delivered.
java.lang.String	getLaunchImage() Returns the optional image name to be shown while the app is loading when an action button is pressed after a push notification is delivered.
java.lang.String	getLocalizedActionKey() Returns the optional key of the localized text to be used as the action button when a push notification is delivered.
java.lang.String	getLocalizedFormatKey() Returns the key of the localized text to be used as the format for the push notification text when it is delivered.
java.lang.String	getSound() Returns the optional sound ID to be played when a push notification is delivered.

Methods inherited from class com.lightstreamer.interfaces.metadata.MpnSubscriptionInfo

getDevice, getTrigger

Methods inherited from class java.lang.Object

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

Constructor Detail

MpnApnsSubscriptionInfo

public MpnApnsSubscriptionInfo(MpnDeviceInfo device,
                               java.lang.String sound,
                               java.lang.String badge,
                               java.lang.String contentAvailable,
                               java.lang.String localizedActionKey,
                               java.lang.String category,
                               java.lang.String launchImage,
                               java.lang.String format,
                               java.lang.String localizedFormatKey,
                               java.util.List arguments,
                               java.util.Map customData,
                               java.lang.String trigger)

Used by Lightstreamer to create an MpnApnsSubscriptionInfo instance, collecting all the details of a push notifications specification for Apple's APNS.

Parameters:

device - a MPN device specification.

sound - the sound ID to be played when a push notification is delivered.

badge - the value for the icon badge when a push notification is delivered.

contentAvailable - the flag to signal the availability of new content to a Newsstand application through the delivery of a push notification.

localizedActionKey - the key of the localized text to be used as the action button when a push notification is delivered.

category - the category of the push notification, to be used by the receiving application to present appropriate action buttons (used only by devices with iOS 8 and greater).

launchImage - the image name to be shown while the app is loading when an action button is pressed after a push notification is delivered.

format - the format for the push notification text when it is delivered.

localizedFormatKey - the key of the localized text to be used as the format for the push notification text when it is delivered.

arguments - the list of arguments to be used with a localized format key.

customData - the map of custom key-value pairs to be added to the push notification.

trigger - the expression the updates are checked against to trigger the notification.

Method Detail

getSound

public java.lang.String getSound()

Returns the optional sound ID to be played when a push notification is delivered.

Returns:

a sound ID, or null.

getBadge

public java.lang.String getBadge()

Returns the optional value for the icon badge when a push notification is delivered.

Returns:

an icon badge value, or null.

getContentAvailable

public java.lang.String getContentAvailable()

Returns the optional flag to signal the availability of new content to a Newsstand application through the delivery of a push notification.

Returns:

a flag value, or null.

getLocalizedActionKey

public java.lang.String getLocalizedActionKey()

Returns the optional key of the localized text to be used as the action button when a push notification is delivered.

Returns:

the key of a localized text, or null.

getCategory

public java.lang.String getCategory()

Returns the optional category of the mobile push notification, to be used by the receiving application to present appropriate action buttons.
Note: only devices with iOS 8 or greater use this property..

Returns:

the category of the mobile push notification, or null.

getLaunchImage

public java.lang.String getLaunchImage()

Returns the optional image name to be shown while the app is loading when an action button is pressed after a push notification is delivered.

Returns:

an image name, or null.

getFormat

public java.lang.String getFormat()

Returns the format for the push notification text when it is delivered.

Returns:

the format of a notification text, or null if a localized format key has been supplied instead.

getLocalizedFormatKey

public java.lang.String getLocalizedFormatKey()

Returns the key of the localized text to be used as the format for the push notification text when it is delivered. A localized format key may be specified only if an explicit format is not supplied.

Returns:

the key of a localized text, on null if an explicit format has been supplied.

getArguments

public java.util.List getArguments()

Returns the list of optional arguments to be used with a localized format key.

Returns:

a list of string arguments; it may be empty. The list cannot be modified.

getCustomData

public java.util.Map getCustomData()

Returns the map of optional custom key-value pairs to be added to the push notification.

Returns:

a map of key-value string pairs; it may be empty. The map cannot be modified.