Package io.agora.rtm

Enum Class RtmConstants.RtmLinkState

java.lang.Object

java.lang.Enum<RtmConstants.RtmLinkState>

io.agora.rtm.RtmConstants.RtmLinkState

All Implemented Interfaces:

Serializable, Comparable<RtmConstants.RtmLinkState>, Constable

Enclosing class:

RtmConstants

public static enum RtmConstants.RtmLinkState
extends Enum<RtmConstants.RtmLinkState>

Rtm link state.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONNECTED	2: The SDK has connected to the server.
CONNECTING	1: The SDK is connecting to the server.
DISCONNECTED	3: The SDK is disconnected from the server.
FAILED	5: The SDK is failed to connect to the server.
IDLE	0: The initial state.
SUSPENDED	4: The SDK link is suspended.

Method Summary

Modifier and Type	Method	Description
static RtmConstants.RtmLinkState	getEnum(int value)
static int	getValue(RtmConstants.RtmLinkState state)
static RtmConstants.RtmLinkState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RtmConstants.RtmLinkState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IDLE

public static final RtmConstants.RtmLinkState IDLE

0: The initial state.

CONNECTING

public static final RtmConstants.RtmLinkState CONNECTING

1: The SDK is connecting to the server.

CONNECTED

public static final RtmConstants.RtmLinkState CONNECTED

2: The SDK has connected to the server.

DISCONNECTED

public static final RtmConstants.RtmLinkState DISCONNECTED

3: The SDK is disconnected from the server.

SUSPENDED

public static final RtmConstants.RtmLinkState SUSPENDED

4: The SDK link is suspended.

FAILED

public static final RtmConstants.RtmLinkState FAILED

5: The SDK is failed to connect to the server.

Method Details

values

public static RtmConstants.RtmLinkState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static RtmConstants.RtmLinkState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public static int getValue(RtmConstants.RtmLinkState state)

getEnum

public static RtmConstants.RtmLinkState getEnum(int value)