io.ably.lib.realtime

Enum ChannelEvent

java.lang.Object

java.lang.Enum<ChannelEvent>

io.ably.lib.realtime.ChannelEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ChannelEvent>

public enum ChannelEvent
extends java.lang.Enum<ChannelEvent>

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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static ChannelEvent	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ChannelEvent[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static ChannelEvent[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ChannelEvent c : ChannelEvent.values())
    System.out.println(c);

Returns:

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

valueOf

public static ChannelEvent valueOf(java.lang.String name)

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

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null