Package io.ably.lib.types

Enum Class ChannelMode

java.lang.Object

java.lang.Enum<ChannelMode>

io.ably.lib.types.ChannelMode

All Implemented Interfaces:

Serializable, Comparable<ChannelMode>, Constable

public enum ChannelMode
extends Enum<ChannelMode>

Describes the possible flags used to configure client capabilities, using ChannelOptions.

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
presence	The client can enter the presence set.
presence_subscribe	The client can receive presence messages.
publish	The client can publish messages.
subscribe	The client can subscribe to messages.

Method Summary

Modifier and Type	Method	Description
int	getMask()
static Set<ChannelMode>	toSet(int flags)
static ChannelMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChannelMode[]	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

presence

public static final ChannelMode presence

The client can enter the presence set.

publish

public static final ChannelMode publish

The client can publish messages.

subscribe

public static final ChannelMode subscribe

The client can subscribe to messages.

presence_subscribe

public static final ChannelMode presence_subscribe

The client can receive presence messages.

Method Details

values

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

getMask

public int getMask()

toSet

public static Set<ChannelMode> toSet(int flags)