com.heroiclabs.nakama.api

Enum UserGroupList.UserGroup.State

java.lang.Object

java.lang.Enum<UserGroupList.UserGroup.State>

com.heroiclabs.nakama.api.UserGroupList.UserGroup.State

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<UserGroupList.UserGroup.State>

Enclosing class:

UserGroupList.UserGroup

public static enum UserGroupList.UserGroup.State
extends java.lang.Enum<UserGroupList.UserGroup.State>
implements com.google.protobuf.ProtocolMessageEnum

 The group role status.
 

Protobuf enum nakama.api.UserGroupList.UserGroup.State

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMIN The user is an admin with additional privileges.
JOIN_REQUEST The user has requested to join the group
MEMBER The user is a regular member.
SUPERADMIN The user is a superadmin with full control of the group.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADMIN_VALUE The user is an admin with additional privileges.
static int	JOIN_REQUEST_VALUE The user has requested to join the group
static int	MEMBER_VALUE The user is a regular member.
static int	SUPERADMIN_VALUE The user is a superadmin with full control of the group.

Method Summary

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

SUPERADMIN

public static final UserGroupList.UserGroup.State SUPERADMIN

 The user is a superadmin with full control of the group.
 

SUPERADMIN = 0;

ADMIN

public static final UserGroupList.UserGroup.State ADMIN

 The user is an admin with additional privileges.
 

ADMIN = 1;

MEMBER

public static final UserGroupList.UserGroup.State MEMBER

 The user is a regular member.
 

MEMBER = 2;

JOIN_REQUEST

public static final UserGroupList.UserGroup.State JOIN_REQUEST

 The user has requested to join the group
 

JOIN_REQUEST = 3;

UNRECOGNIZED

public static final UserGroupList.UserGroup.State UNRECOGNIZED

Field Detail

SUPERADMIN_VALUE

public static final int SUPERADMIN_VALUE

 The user is a superadmin with full control of the group.
 

SUPERADMIN = 0;

See Also:

Constant Field Values

ADMIN_VALUE

public static final int ADMIN_VALUE

 The user is an admin with additional privileges.
 

ADMIN = 1;

See Also:

Constant Field Values

MEMBER_VALUE

public static final int MEMBER_VALUE

 The user is a regular member.
 

MEMBER = 2;

See Also:

Constant Field Values

JOIN_REQUEST_VALUE

public static final int JOIN_REQUEST_VALUE

 The user has requested to join the group
 

JOIN_REQUEST = 3;

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static UserGroupList.UserGroup.State 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 UserGroupList.UserGroup.State 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 UserGroupList.UserGroup.State 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<UserGroupList.UserGroup.State> 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 UserGroupList.UserGroup.State valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)