com.heroiclabs.nakama.api

Enum Friend.State

java.lang.Object

java.lang.Enum<Friend.State>

com.heroiclabs.nakama.api.Friend.State

All Implemented Interfaces:

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

Enclosing class:

Friend

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

 The friendship status.
 

Protobuf enum nakama.api.Friend.State

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCKED The current user has blocked this user.
FRIEND The user is a friend of the current user.
INVITE_RECEIVED The current user has received an invite from this user.
INVITE_SENT The current user has sent an invite to the user.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCKED_VALUE The current user has blocked this user.
static int	FRIEND_VALUE The user is a friend of the current user.
static int	INVITE_RECEIVED_VALUE The current user has received an invite from this user.
static int	INVITE_SENT_VALUE The current user has sent an invite to the user.

Method Summary

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

FRIEND

public static final Friend.State FRIEND

 The user is a friend of the current user.
 

FRIEND = 0;

INVITE_SENT

public static final Friend.State INVITE_SENT

 The current user has sent an invite to the user.
 

INVITE_SENT = 1;

INVITE_RECEIVED

public static final Friend.State INVITE_RECEIVED

 The current user has received an invite from this user.
 

INVITE_RECEIVED = 2;

BLOCKED

public static final Friend.State BLOCKED

 The current user has blocked this user.
 

BLOCKED = 3;

UNRECOGNIZED

public static final Friend.State UNRECOGNIZED

Field Detail

FRIEND_VALUE

public static final int FRIEND_VALUE

 The user is a friend of the current user.
 

FRIEND = 0;

See Also:

Constant Field Values

INVITE_SENT_VALUE

public static final int INVITE_SENT_VALUE

 The current user has sent an invite to the user.
 

INVITE_SENT = 1;

See Also:

Constant Field Values

INVITE_RECEIVED_VALUE

public static final int INVITE_RECEIVED_VALUE

 The current user has received an invite from this user.
 

INVITE_RECEIVED = 2;

See Also:

Constant Field Values

BLOCKED_VALUE

public static final int BLOCKED_VALUE

 The current user has blocked this user.
 

BLOCKED = 3;

See Also:

Constant Field Values

Method Detail

values

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