Package io.agora.rtm

Enum Class RtmConstants.RtmPresenceEventType

java.lang.Object

java.lang.Enum<RtmConstants.RtmPresenceEventType>

io.agora.rtm.RtmConstants.RtmPresenceEventType

All Implemented Interfaces:

Serializable, Comparable<RtmConstants.RtmPresenceEventType>, Constable

Enclosing class:

RtmConstants

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

Presence event type

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
ERROR_OUT_OF_SERVICE	7: Triggered when user joined channel without presence service
INTERVAL	2: The presence event triggered in interval mode
NONE	0: Unknown event type
REMOTE_JOIN	3: Triggered when remote user join channel
REMOTE_LEAVE	4: Triggered when remote user leave channel
REMOTE_STATE_CHANGED	6: Triggered when user changed state
REMOTE_TIMEOUT	5: Triggered when remote user's connection timeout
SNAPSHOT	1: The presence snapshot of this channel

Method Summary

Modifier and Type	Method	Description
static RtmConstants.RtmPresenceEventType	getEnum(int value)
static int	getValue(RtmConstants.RtmPresenceEventType type)
static RtmConstants.RtmPresenceEventType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RtmConstants.RtmPresenceEventType[]	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

NONE

public static final RtmConstants.RtmPresenceEventType NONE

0: Unknown event type

SNAPSHOT

public static final RtmConstants.RtmPresenceEventType SNAPSHOT

1: The presence snapshot of this channel

INTERVAL

public static final RtmConstants.RtmPresenceEventType INTERVAL

2: The presence event triggered in interval mode

REMOTE_JOIN

public static final RtmConstants.RtmPresenceEventType REMOTE_JOIN

3: Triggered when remote user join channel

REMOTE_LEAVE

public static final RtmConstants.RtmPresenceEventType REMOTE_LEAVE

4: Triggered when remote user leave channel

REMOTE_TIMEOUT

public static final RtmConstants.RtmPresenceEventType REMOTE_TIMEOUT

5: Triggered when remote user's connection timeout

REMOTE_STATE_CHANGED

public static final RtmConstants.RtmPresenceEventType REMOTE_STATE_CHANGED

6: Triggered when user changed state

ERROR_OUT_OF_SERVICE

public static final RtmConstants.RtmPresenceEventType ERROR_OUT_OF_SERVICE

7: Triggered when user joined channel without presence service

Method Details

values

public static RtmConstants.RtmPresenceEventType[] 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.RtmPresenceEventType 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.RtmPresenceEventType type)

getEnum

public static RtmConstants.RtmPresenceEventType getEnum(int value)