com.heroiclabs.nakama.api

Class Leaderboard

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.heroiclabs.nakama.api.Leaderboard

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LeaderboardOrBuilder, java.io.Serializable

public final class Leaderboard
extends com.google.protobuf.GeneratedMessage
implements LeaderboardOrBuilder

 A leaderboard on the server.
 

Protobuf type nakama.api.Leaderboard

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Leaderboard.Builder A leaderboard on the server.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTHORITATIVE_FIELD_NUMBER
static int	CREATE_TIME_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	METADATA_FIELD_NUMBER
static int	NEXT_RESET_FIELD_NUMBER
static int	OPERATOR_FIELD_NUMBER
static int	PREV_RESET_FIELD_NUMBER
static int	SORT_ORDER_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
boolean	getAuthoritative() Whether the leaderboard was created authoritatively or not.
com.google.protobuf.Timestamp	getCreateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
static Leaderboard	getDefaultInstance()
Leaderboard	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
java.lang.String	getId() The ID of the leaderboard.
com.google.protobuf.ByteString	getIdBytes() The ID of the leaderboard.
java.lang.String	getMetadata() Additional information stored as a JSON object.
com.google.protobuf.ByteString	getMetadataBytes() Additional information stored as a JSON object.
int	getNextReset() The UNIX time when the leaderboard is next playable.
Operator	getOperator() BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
int	getOperatorValue() BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
com.google.protobuf.Parser<Leaderboard>	getParserForType()
int	getPrevReset() The UNIX time when the leaderboard was previously reset.
int	getSerializedSize()
int	getSortOrder() ASC(0) or DESC(1) sort mode of scores in the leaderboard.
boolean	hasCreateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Leaderboard.Builder	newBuilder()
static Leaderboard.Builder	newBuilder(Leaderboard prototype)
Leaderboard.Builder	newBuilderForType()
protected Leaderboard.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Leaderboard	parseDelimitedFrom(java.io.InputStream input)
static Leaderboard	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Leaderboard	parseFrom(byte[] data)
static Leaderboard	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Leaderboard	parseFrom(java.nio.ByteBuffer data)
static Leaderboard	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Leaderboard	parseFrom(com.google.protobuf.ByteString data)
static Leaderboard	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Leaderboard	parseFrom(com.google.protobuf.CodedInputStream input)
static Leaderboard	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Leaderboard	parseFrom(java.io.InputStream input)
static Leaderboard	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Leaderboard>	parser()
Leaderboard.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

SORT_ORDER_FIELD_NUMBER

public static final int SORT_ORDER_FIELD_NUMBER

See Also:

Constant Field Values

OPERATOR_FIELD_NUMBER

public static final int OPERATOR_FIELD_NUMBER

See Also:

Constant Field Values

PREV_RESET_FIELD_NUMBER

public static final int PREV_RESET_FIELD_NUMBER

See Also:

Constant Field Values

NEXT_RESET_FIELD_NUMBER

public static final int NEXT_RESET_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

AUTHORITATIVE_FIELD_NUMBER

public static final int AUTHORITATIVE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getId

public java.lang.String getId()

 The ID of the leaderboard.
 

string id = 1 [json_name = "id"];

Specified by:

getId in interface LeaderboardOrBuilder

Returns:

The id.

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 The ID of the leaderboard.
 

string id = 1 [json_name = "id"];

Specified by:

getIdBytes in interface LeaderboardOrBuilder

Returns:

The bytes for id.

getSortOrder

public int getSortOrder()

 ASC(0) or DESC(1) sort mode of scores in the leaderboard.
 

uint32 sort_order = 2 [json_name = "sortOrder"];

Specified by:

getSortOrder in interface LeaderboardOrBuilder

Returns:

The sortOrder.

getOperatorValue

public int getOperatorValue()

 BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
 

.nakama.api.Operator operator = 3 [json_name = "operator"];

Specified by:

getOperatorValue in interface LeaderboardOrBuilder

Returns:

The enum numeric value on the wire for operator.

getOperator

public Operator getOperator()

 BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
 

.nakama.api.Operator operator = 3 [json_name = "operator"];

Specified by:

getOperator in interface LeaderboardOrBuilder

Returns:

The operator.

getPrevReset

public int getPrevReset()

 The UNIX time when the leaderboard was previously reset. A computed value.
 

uint32 prev_reset = 4 [json_name = "prevReset"];

Specified by:

getPrevReset in interface LeaderboardOrBuilder

Returns:

The prevReset.

getNextReset

public int getNextReset()

 The UNIX time when the leaderboard is next playable. A computed value.
 

uint32 next_reset = 5 [json_name = "nextReset"];

Specified by:

getNextReset in interface LeaderboardOrBuilder

Returns:

The nextReset.

getMetadata

public java.lang.String getMetadata()

 Additional information stored as a JSON object.
 

string metadata = 6 [json_name = "metadata"];

Specified by:

getMetadata in interface LeaderboardOrBuilder

Returns:

The metadata.

getMetadataBytes

public com.google.protobuf.ByteString getMetadataBytes()

 Additional information stored as a JSON object.
 

string metadata = 6 [json_name = "metadata"];

Specified by:

getMetadataBytes in interface LeaderboardOrBuilder

Returns:

The bytes for metadata.

hasCreateTime

public boolean hasCreateTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
 

.google.protobuf.Timestamp create_time = 7 [json_name = "createTime"];

Specified by:

hasCreateTime in interface LeaderboardOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
 

.google.protobuf.Timestamp create_time = 7 [json_name = "createTime"];

Specified by:

getCreateTime in interface LeaderboardOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
 

.google.protobuf.Timestamp create_time = 7 [json_name = "createTime"];

Specified by:

getCreateTimeOrBuilder in interface LeaderboardOrBuilder

getAuthoritative

public boolean getAuthoritative()

 Whether the leaderboard was created authoritatively or not.
 

bool authoritative = 8 [json_name = "authoritative"];

Specified by:

getAuthoritative in interface LeaderboardOrBuilder

Returns:

The authoritative.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Leaderboard parseFrom(java.nio.ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Leaderboard parseFrom(java.nio.ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Leaderboard parseFrom(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Leaderboard parseFrom(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Leaderboard parseFrom(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Leaderboard parseFrom(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Leaderboard parseFrom(java.io.InputStream input)
                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Leaderboard parseFrom(java.io.InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Leaderboard parseDelimitedFrom(java.io.InputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Leaderboard parseDelimitedFrom(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Leaderboard parseFrom(com.google.protobuf.CodedInputStream input)
                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Leaderboard parseFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Leaderboard.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Leaderboard.Builder newBuilder()

newBuilder

public static Leaderboard.Builder newBuilder(Leaderboard prototype)

toBuilder

public Leaderboard.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Leaderboard.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Leaderboard getDefaultInstance()

parser

public static com.google.protobuf.Parser<Leaderboard> parser()

getParserForType

public com.google.protobuf.Parser<Leaderboard> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public Leaderboard getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder