com.lightstreamer.client.mpn.android

Class MpnDevice

java.lang.Object

com.lightstreamer.client.mpn.AbstractMpnDevice

com.lightstreamer.client.mpn.android.MpnDevice

All Implemented Interfaces:

MpnDeviceInterface

public class MpnDevice
extends AbstractMpnDevice

Class representing a device that supports Mobile Push Notifications (MPN).
It contains device details and the listener needed to monitor its status.
An MPN device is created from the application context, the sender ID (a.k.a. authorized entity) and a device token (a.k.a. registration token) obtained from Firebase Cloud Messaging APIs, and must be registered on the LightstreamerClient in order to successfully subscribe an MPN subscription. See MpnSubscription.
A factory method, create(Context, String, MpnDeviceCreationListener), is also provided to obtain the device token automatically. If it succeeds, it creates the MpnDevice object with it.
After creation, an MpnDevice object is in "unknown" state. It must then be passed to the Lightstreamer Server with the LightstreamerClient.registerForMpn(MpnDeviceInterface) method, which enables the client to subscribe MPN subscriptions and sends the device details to the server's MPN Module, where it is assigned a permanent device ID and its state is switched to "registered".
Upon registration on the server, active MPN subscriptions of the device are received and exposed with the LightstreamerClient.getMpnSubscriptions(String) method.
An MpnDevice's state may become "suspended" if errors occur during push notification delivery. In this case MPN subscriptions stop sending notifications and the device state is reset to "registered" only when a new device token is provided.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MpnDevice.MpnDeviceCreationListener Interface to be implemented to receive success or failure MpnDevice creation events.

Constructor Summary

Constructors

Constructor and Description

MpnDevice(android.content.Context appContext, java.lang.String senderId, java.lang.String token) Creates an object to be used to describe an MPN device that is going to be registered to the MPN Module of Lightstreamer Server. During creation the MpnDevice tries to acquires some more details: The package name, through the Application Context. Any previously registered device token, from the Shared Preferences storage. It then saves the current device token on the Shared Preferences storage.

Method Summary

Modifier and Type	Method and Description
static void	create(android.content.Context appContext, java.lang.String senderId, MpnDevice.MpnDeviceCreationListener listener) Factory method that creates an MpnDevice object to be registered to the MPN Module of Lightstreamer Server. During creation the factory method and the MpnDevice try to acquires some more details: The device token, through the Firebase Cloud Messaging APIs. The package name, through the Application Context. Any previously registered device token, from the Shared Preferences storage. The MpnDevice then saves the current device token on the Shared Preferences storage.
java.lang.String	getPlatform() The platform identifier of this MPN device.

Methods inherited from class com.lightstreamer.client.mpn.AbstractMpnDevice

addListener, getApplicationId, getDeviceId, getDeviceToken, getListeners, getPreviousDeviceToken, getStatus, getStatusTimestamp, isRegistered, isSuspended, removeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

MpnDevice

public MpnDevice(@Nonnull
                 android.content.Context appContext,
                 @Nonnull
                 java.lang.String senderId,
                 @Nonnull
                 java.lang.String token)

Creates an object to be used to describe an MPN device that is going to be registered to the MPN Module of Lightstreamer Server.
During creation the MpnDevice tries to acquires some more details:

• The package name, through the Application Context.
• Any previously registered device token, from the Shared Preferences storage.

It then saves the current device token on the Shared Preferences storage. Saving and retrieving the previous device token is used to handle automatically the cases where the token changes, such as when the app state is restored from a device backup. The MPN Module of Lightstreamer Server is able to move MPN subscriptions associated with the previous token to the new one.

Parameters:

appContext - the Application Context

senderId - the Sender ID (a.k.a. the Authorized Entity) as obtained from the app's project console.

token - the device token

Throws:

java.lang.IllegalArgumentException - if context, senderId or token are null.

Method Detail

create

public static void create(@Nonnull
                          android.content.Context appContext,
                          @Nonnull
                          java.lang.String senderId,
                          @Nonnull
                          MpnDevice.MpnDeviceCreationListener listener)

Factory method that creates an MpnDevice object to be registered to the MPN Module of Lightstreamer Server.
During creation the factory method and the MpnDevice try to acquires some more details:

• The device token, through the Firebase Cloud Messaging APIs.
• The package name, through the Application Context.
• Any previously registered device token, from the Shared Preferences storage.

The MpnDevice then saves the current device token on the Shared Preferences storage. Saving and retrieving the previous device token is used to handle automatically the cases where the token changes, such as when the app state is restored from a device backup. The MPN Module of Lightstreamer Server is able to move MPN subscriptions associated with the previous token to the new one.
If the creation succeeds, the MpnDevice object is passed to MpnDevice.MpnDeviceCreationListener.onSuccess(MpnDevice). In case of error MpnDevice.MpnDeviceCreationListener.onFailure(Exception) is called.

Parameters:

appContext - the Application Context

senderId - the Sender ID (a.k.a. the Authorized Entity) as obtained from the app's project console.

listener - the MpnDevice creation listener

Throws:

java.lang.IllegalArgumentException - if context, senderId or listener are null.

getPlatform

public java.lang.String getPlatform()

The platform identifier of this MPN device. It equals to the constant Google and is used by the server as part of the device identification.

Returns:

the MPN device platform.

Lifecycle:

This method can be called at any time.