com.lightstreamer.adapters.remote

Class MpnSubscriptionInfo.MpnApnsSubscriptionInfo

java.lang.Object

com.lightstreamer.adapters.remote.MpnSubscriptionInfo

com.lightstreamer.adapters.remote.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.adapters.remote.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 localizedActionKey, java.lang.String launchImage, java.lang.String format, java.lang.String localizedFormatKey, java.util.List<java.lang.String> arguments, java.util.Map<java.lang.String,java.lang.String> 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<java.lang.String>	getArguments() Gets the list of optional arguments to be used with a localized format key.
java.lang.String	getBadge() Gets the optional value for the icon badge when a push notification is delivered.
java.util.Map<java.lang.String,java.lang.String>	getCustomData() Gets the map of optional custom key-value pairs to be added to the push notification.
java.lang.String	getFormat() Gets the format for the push notification text when it is delivered.
java.lang.String	getLaunchImage() Gets the optional image name to be shown while the app is loading when the action.
java.lang.String	getLocalizedActionKey() Gets the optional key of the localized text to be used as the action button when a push notification is delivered.
java.lang.String	getLocalizedFormatKey() Gets 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() Gets the optional sound ID to be played when a push notification is delivered.

Methods inherited from class com.lightstreamer.adapters.remote.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 localizedActionKey,
                               java.lang.String launchImage,
                               java.lang.String format,
                               java.lang.String localizedFormatKey,
                               java.util.List<java.lang.String> arguments,
                               java.util.Map<java.lang.String,java.lang.String> 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.

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

launchImage - The image name to be shown while the app is loading when the 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 final java.lang.String getSound()

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

Returns:

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

getBadge

public final java.lang.String getBadge()

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

Returns:

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

getLocalizedActionKey

public final java.lang.String getLocalizedActionKey()

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

Returns:

the optional key of the localized text

getLaunchImage

public final java.lang.String getLaunchImage()

Gets the optional image name to be shown while the app is loading when the action.

Returns:

the optional image name to be shown while the app is loading when the action

getFormat

public final java.lang.String getFormat()

Gets the format for the push notification text when it is delivered. May be null if a localized format key is supplied instead.

Returns:

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

getLocalizedFormatKey

public final java.lang.String getLocalizedFormatKey()

Gets the key of the localized text to be used as the format for the push notification text when it is delivered. May be null if an explicit format is supplied instead.

Returns:

the key of the localized text to be used as the format

getArguments

public final java.util.List<java.lang.String> getArguments()

Gets the list of optional arguments to be used with a localized format key. May be empty.

Returns:

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

getCustomData

public final java.util.Map<java.lang.String,java.lang.String> getCustomData()

Gets the map of optional custom key-value pairs to be added to the push notification. May be empty.

Returns:

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