org.linphone.core

Enum SubscriptionState

java.lang.Object

java.lang.Enum<SubscriptionState>

org.linphone.core.SubscriptionState

All Implemented Interfaces:

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

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

Enum for subscription states.

Terminated and Error are
final states.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Active Subscription is accepted.
Error Subscription was terminated by an error, indicated by Event.getReason()
Expiring Subscription is about to expire, only sent if [sip]->refresh_generic_subscribe property is set to 0.
IncomingReceived An incoming subcription is received.
None Initial state, should not be used.
OutgoingProgress An outgoing subcription was sent.
Pending Subscription is pending, waiting for user approval.
Terminated Subscription is terminated normally.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mValue

Method Summary

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

None

public static final SubscriptionState None

Initial state, should not be used.

OutgoingProgress

public static final SubscriptionState OutgoingProgress

An outgoing subcription was sent.

IncomingReceived

public static final SubscriptionState IncomingReceived

An incoming subcription is received.

Pending

public static final SubscriptionState Pending

Subscription is pending, waiting for user approval.

Active

public static final SubscriptionState Active

Subscription is accepted.

Terminated

public static final SubscriptionState Terminated

Subscription is terminated normally.

Error

public static final SubscriptionState Error

Subscription was terminated by an error, indicated by Event.getReason()

Expiring

public static final SubscriptionState Expiring

Subscription is about to expire, only sent if [sip]->refresh_generic_subscribe
property is set to 0.

Field Detail

mValue

protected final int mValue

Method Detail

values

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

Returns:

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

valueOf

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

fromInt

public static SubscriptionState fromInt(int value)
                                 throws java.lang.RuntimeException

Throws:

java.lang.RuntimeException

toInt

public int toInt()