net.java.sip.communicator.service.protocol
Enum ConferenceMemberState

java.lang.Object
  java.lang.Enum<ConferenceMemberState>
      net.java.sip.communicator.service.protocol.ConferenceMemberState

All Implemented Interfaces:

Serializable, Comparable<ConferenceMemberState>

public enum ConferenceMemberState
extends Enum<ConferenceMemberState>

Represents the state of the device and signaling session of ConferenceMember in the conference it is participating in.

Author:

Lubomir Marinov, Yana Stamcheva

Enum Constant Summary

ALERTING
A Public Switched Telephone Network (PSTN) ALERTING or SIP 180 Ringing was returned for the outbound call; endpoint is being alerted.

CONNECTED
The endpoint is a participant in the conference.

DIALING_IN
Endpoint is dialing into the conference, not yet in the roster (probably being authenticated).

DIALING_OUT
Focus has dialed out to connect the endpoint to the conference, but the endpoint is not yet in the roster (probably being authenticated).

DISCONNECTED
The endpoint is not a participant in the conference, and no active dialog exists between the endpoint and the focus.

DISCONNECTING
Focus is in the process of disconnecting the endpoint (e.g., in SIP a DISCONNECT or BYE was sent to the endpoint).

MUTED_VIA_FOCUS
Active signaling dialog exists between an endpoint and a focus and the endpoint can "listen" to the conference, but the endpoint's media is not being mixed into the conference.

ON_HOLD
Active signaling dialog exists between an endpoint and a focus, but endpoint is "on-hold" for this conference, i.e., he/she is neither "hearing" the conference mix nor is his/her media being mixed in the conference.

PENDING
Endpoint is not yet in the session, but it is anticipated that he/she will join in the near future.

UNKNOWN
The state of the device and signaling session of the associated ConferenceMember in the conference is unknown.

Method Summary

String	toString() Returns the name of this ConferenceMemberState (e.g.
static ConferenceMemberState	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConferenceMemberState[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALERTING

public static final ConferenceMemberState ALERTING

A Public Switched Telephone Network (PSTN) ALERTING or SIP 180 Ringing was returned for the outbound call; endpoint is being alerted.

CONNECTED

public static final ConferenceMemberState CONNECTED

The endpoint is a participant in the conference. Depending on the media policies, he/she can send and receive media to and from other participants.

DIALING_IN

public static final ConferenceMemberState DIALING_IN

Endpoint is dialing into the conference, not yet in the roster (probably being authenticated).

DIALING_OUT

public static final ConferenceMemberState DIALING_OUT

Focus has dialed out to connect the endpoint to the conference, but the endpoint is not yet in the roster (probably being authenticated).

DISCONNECTED

public static final ConferenceMemberState DISCONNECTED

The endpoint is not a participant in the conference, and no active dialog exists between the endpoint and the focus.

DISCONNECTING

public static final ConferenceMemberState DISCONNECTING

Focus is in the process of disconnecting the endpoint (e.g., in SIP a DISCONNECT or BYE was sent to the endpoint).

MUTED_VIA_FOCUS

public static final ConferenceMemberState MUTED_VIA_FOCUS

Active signaling dialog exists between an endpoint and a focus and the endpoint can "listen" to the conference, but the endpoint's media is not being mixed into the conference.

ON_HOLD

public static final ConferenceMemberState ON_HOLD

Active signaling dialog exists between an endpoint and a focus, but endpoint is "on-hold" for this conference, i.e., he/she is neither "hearing" the conference mix nor is his/her media being mixed in the conference.

PENDING

public static final ConferenceMemberState PENDING

Endpoint is not yet in the session, but it is anticipated that he/she will join in the near future.

UNKNOWN

public static final ConferenceMemberState UNKNOWN

The state of the device and signaling session of the associated ConferenceMember in the conference is unknown.

Method Detail

values

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

Returns:

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

valueOf

public static ConferenceMemberState valueOf(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:

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

NullPointerException - if the argument is null

toString

public String toString()

Returns the name of this ConferenceMemberState (e.g. "connected" or "dialing out"). The name returned by this method is meant to be used by user interface implementations in order to provide more readable state string.

Overrides:

toString in class Enum<ConferenceMemberState>

Returns:

the name of this ConferenceMemberState (e.g. "connected" or "dialing out")