Package io.ably.lib.realtime

Enum Class ChannelEvent

java.lang.Object

java.lang.Enum<ChannelEvent>

io.ably.lib.realtime.ChannelEvent

All Implemented Interfaces:

Serializable, Comparable<ChannelEvent>, Constable

public enum ChannelEvent
extends Enum<ChannelEvent>

Describes the events emitted by a Channel object. An event is either an UPDATE or a ChannelState.

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
attached
attaching
detached
detaching
failed
initialized
suspended
update	An event for changes to channel conditions that do not result in a change in ChannelState.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

initialized

public static final ChannelEvent initialized

attaching

public static final ChannelEvent attaching

attached

public static final ChannelEvent attached

detaching

public static final ChannelEvent detaching

detached

public static final ChannelEvent detached

failed

public static final ChannelEvent failed

suspended

public static final ChannelEvent suspended

update

public static final ChannelEvent update

An event for changes to channel conditions that do not result in a change in ChannelState.

Spec: RTL2g

Method Details

values

public static ChannelEvent[] 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 ChannelEvent 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