com.lightstreamer.ls_client.mpn

Enum MpnSubscriptionStatus

java.lang.Object

java.lang.Enum<MpnSubscriptionStatus>

com.lightstreamer.ls_client.mpn.MpnSubscriptionStatus

All Implemented Interfaces:

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

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

The MpnSubscriptionStatus enum contains the possible statuses of an MPN subscription. It is returned as the subscriptionStatus field of MpnStatusInfo by the MpnSubscription.checkStatus() method. It is also used to specify a filter for calls to LSClient.deactivateMpn(MpnSubscriptionStatus) and LSClient.inquireMpn(MpnSubscriptionStatus).
Its significant values are:

• Active: the MPN subscription is active (if it has a trigger expression, it has not triggered yet);
• Triggered: the MPN subscription is active and it has a trigger expression that has already triggered;

The Active value is the common status of an MPN subscription. If it has no trigger expression, it means the MPN subscription is sending its mobile push notifications (i.e. cloud messages) as usual. If it has a trigger expression, it means the MPN subscription is waiting for it to evaluate as true.
Triggered status indicates the MPN subscription has already sent its only notification and may safely be deactivated. See MpnInfo.setTriggerExpression(java.lang.String) for more information.
Recall that when a subscription has been deactivated it has also been deleted. Hence, there isn't a corresponding state: a call to MpnSubscription.checkStatus() for such a subscription will result in an PushUserException with error code 46 (subscription unknown) or 45 (device unknown, if no more subscriptions exist for this device and application).

Enum Constant Summary

Enum Constants

Enum Constant and Description
Active MPN subscription status indicating that the subscription is active (if it has a trigger expression, it has not triggered yet).
Triggered MPN subscription status indicating that the subscription is active and it has a trigger expression that has already triggered.

Method Summary

Modifier and Type	Method and Description
static MpnSubscriptionStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MpnSubscriptionStatus[]	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 MpnSubscriptionStatus Active

MPN subscription status indicating that the subscription is active (if it has a trigger expression, it has not triggered yet).

Triggered

public static final MpnSubscriptionStatus Triggered

MPN subscription status indicating that the subscription is active and it has a trigger expression that has already triggered.

Method Detail

values

public static MpnSubscriptionStatus[] 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 (MpnSubscriptionStatus c : MpnSubscriptionStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static MpnSubscriptionStatus 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