Package io.agora.rtm

Enum Class RtmConstants.RtmStorageEventType

java.lang.Object

java.lang.Enum<RtmConstants.RtmStorageEventType>

io.agora.rtm.RtmConstants.RtmStorageEventType

All Implemented Interfaces:

Serializable, Comparable<RtmConstants.RtmStorageEventType>, Constable

Enclosing class:

RtmConstants

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

RTM storage 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
NONE	0: Unknown event type.
REMOVE	4: Triggered when a remote user remove metadata
SET	2: Triggered when a remote user set metadata
SNAPSHOT	1: Triggered when user subscribe user metadata state or join channel with options.withMetadata = true.
UPDATE	3: Triggered when a remote user update metadata

Method Summary

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

0: Unknown event type.

SNAPSHOT

public static final RtmConstants.RtmStorageEventType SNAPSHOT

1: Triggered when user subscribe user metadata state or join channel with options.withMetadata = true.

SET

public static final RtmConstants.RtmStorageEventType SET

2: Triggered when a remote user set metadata

UPDATE

public static final RtmConstants.RtmStorageEventType UPDATE

3: Triggered when a remote user update metadata

REMOVE

public static final RtmConstants.RtmStorageEventType REMOVE

4: Triggered when a remote user remove metadata

Method Details

values

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

getEnum

public static RtmConstants.RtmStorageEventType getEnum(int value)