com.heroiclabs.nakama

Enum ChannelType

java.lang.Object

java.lang.Enum<ChannelType>

com.heroiclabs.nakama.ChannelType

All Implemented Interfaces:

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

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

The available channel types on the server.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIRECT_MESSAGE A private chat between two users.
GROUP A chat within a group on the server.
ROOM A chat room which can be created dynamically with a name.

Method Summary

Modifier and Type	Method and Description
int	getValue()
static ChannelType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ChannelType[]	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

ROOM

public static final ChannelType ROOM

A chat room which can be created dynamically with a name.

DIRECT_MESSAGE

public static final ChannelType DIRECT_MESSAGE

A private chat between two users.

GROUP

public static final ChannelType GROUP

A chat within a group on the server.

Method Detail

values

public static ChannelType[] 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 (ChannelType c : ChannelType.values())
    System.out.println(c);

Returns:

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

valueOf

public static ChannelType 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

getValue

public int getValue()