com.lightstreamer.ls_client.mpn

Enum MpnDeviceStatus

java.lang.Object

java.lang.Enum<MpnDeviceStatus>

com.lightstreamer.ls_client.mpn.MpnDeviceStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MpnDeviceStatus>

public enum MpnDeviceStatus
extends java.lang.Enum<MpnDeviceStatus>

The MpnDeviceStatus enum contains the possible statuses of an MPN device. It is returned as the deviceStatus field of MpnStatusInfo by the MpnSubscription.checkStatus() method.
Its significant values are:

• Active: the MPN device is active (its MPN subscriptions are sending notifications);
• Suspended: the MPN device has been suspended due to invalidation of the registration ID by GCM service.

The Active value is the common status of an MPN device. Active MPN subscriptions related to this device are sending their mobile push notifications (i.e. cloud messages) as usual.
The Suspended status indicates the device is temporarily not active, but it will be reactivated as soon as a registration ID change is notified to the Server. This status is reversible and usually requires no action. See LSClient.registerForMpn(android.content.Context, String, MpnRegistrationListener) for more information. Note that a suspended device may be deactivated (and hence deleted) by the Server, if no registration ID change is notified within a timeout period (by default a week).
Recall that when the last subscription of a device has been deactivated (and hence deleted), the device also is deleted. A call to MpnSubscription.checkStatus() for a device with no more active or triggered subscriptions will result in an PushUserException with error code 45 (device unknown).

Enum Constant Summary

Enum Constants

Enum Constant and Description
Active MPN device status indicating that the device is active (its MPN subscriptions do send notifications).
Suspended MPN device status indicating that the device has been suspended due to invalidation of the registration ID by the GCM service.

Method Summary

Modifier and Type	Method and Description
static MpnDeviceStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MpnDeviceStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Active

public static final MpnDeviceStatus Active

MPN device status indicating that the device is active (its MPN subscriptions do send notifications).

Suspended

public static final MpnDeviceStatus Suspended

MPN device status indicating that the device has been suspended due to invalidation of the registration ID by the GCM service.

Method Detail

values

public static MpnDeviceStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MpnDeviceStatus c : MpnDeviceStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MpnDeviceStatus valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null