Package io.agora.rtm

Enum Class RtmConstants.RtmLockEventType

java.lang.Object

java.lang.Enum<RtmConstants.RtmLockEventType>

io.agora.rtm.RtmConstants.RtmLockEventType

All Implemented Interfaces:

Serializable, Comparable<RtmConstants.RtmLockEventType>, Constable

Enclosing class:

RtmConstants

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

RTM lock 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
ACQUIRED	4: Triggered when a remote user acquired lock
EXPIRED	6: Triggered when user reconnect to rtm service, detect the lock has been acquired and released by others.
NONE	0: Unknown event type
RELEASED	5: Triggered when a remote user released lock
REMOVED	3: Triggered when a remote user remove lock
SET	2: Triggered when a remote user set lock
SNAPSHOT	1: Triggered when user subscribe lock state

Method Summary

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

0: Unknown event type

SNAPSHOT

public static final RtmConstants.RtmLockEventType SNAPSHOT

1: Triggered when user subscribe lock state

SET

public static final RtmConstants.RtmLockEventType SET

2: Triggered when a remote user set lock

REMOVED

public static final RtmConstants.RtmLockEventType REMOVED

3: Triggered when a remote user remove lock

ACQUIRED

public static final RtmConstants.RtmLockEventType ACQUIRED

4: Triggered when a remote user acquired lock

RELEASED

public static final RtmConstants.RtmLockEventType RELEASED

5: Triggered when a remote user released lock

EXPIRED

public static final RtmConstants.RtmLockEventType EXPIRED

6: Triggered when user reconnect to rtm service, detect the lock has been acquired and released by others.

Method Details

values

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

getEnum

public static RtmConstants.RtmLockEventType getEnum(int value)