com.heroiclabs.nakama.rtapi

Enum ChannelJoin.Type

java.lang.Object

java.lang.Enum<ChannelJoin.Type>

com.heroiclabs.nakama.rtapi.ChannelJoin.Type

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<ChannelJoin.Type>

Enclosing class:

ChannelJoin

public static enum ChannelJoin.Type
extends java.lang.Enum<ChannelJoin.Type>
implements com.google.protobuf.ProtocolMessageEnum

 The type of chat channel.
 

Protobuf enum nakama.realtime.ChannelJoin.Type

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIRECT_MESSAGE A private channel for 1-on-1 chat.
GROUP A channel for group chat.
ROOM A room which anyone can join to chat.
TYPE_UNSPECIFIED Default case.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	DIRECT_MESSAGE_VALUE A private channel for 1-on-1 chat.
static int	GROUP_VALUE A channel for group chat.
static int	ROOM_VALUE A room which anyone can join to chat.
static int	TYPE_UNSPECIFIED_VALUE Default case.

Method Summary

Modifier and Type	Method and Description
static ChannelJoin.Type	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<ChannelJoin.Type>	internalGetValueMap()
static ChannelJoin.Type	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static ChannelJoin.Type	valueOf(int value) Deprecated. Use forNumber(int) instead.
static ChannelJoin.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ChannelJoin.Type[]	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

TYPE_UNSPECIFIED

public static final ChannelJoin.Type TYPE_UNSPECIFIED

 Default case. Assumed as ROOM type.
 

TYPE_UNSPECIFIED = 0;

ROOM

public static final ChannelJoin.Type ROOM

 A room which anyone can join to chat.
 

ROOM = 1;

DIRECT_MESSAGE

public static final ChannelJoin.Type DIRECT_MESSAGE

 A private channel for 1-on-1 chat.
 

DIRECT_MESSAGE = 2;

GROUP

public static final ChannelJoin.Type GROUP

 A channel for group chat.
 

GROUP = 3;

UNRECOGNIZED

public static final ChannelJoin.Type UNRECOGNIZED

Field Detail

TYPE_UNSPECIFIED_VALUE

public static final int TYPE_UNSPECIFIED_VALUE

 Default case. Assumed as ROOM type.
 

TYPE_UNSPECIFIED = 0;

See Also:

Constant Field Values

ROOM_VALUE

public static final int ROOM_VALUE

 A room which anyone can join to chat.
 

ROOM = 1;

See Also:

Constant Field Values

DIRECT_MESSAGE_VALUE

public static final int DIRECT_MESSAGE_VALUE

 A private channel for 1-on-1 chat.
 

DIRECT_MESSAGE = 2;

See Also:

Constant Field Values

GROUP_VALUE

public static final int GROUP_VALUE

 A channel for group chat.
 

GROUP = 3;

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static ChannelJoin.Type 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

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static ChannelJoin.Type valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static ChannelJoin.Type forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<ChannelJoin.Type> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static ChannelJoin.Type valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)