com.heroiclabs.nakama.api

Interface LeaderboardOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Leaderboard, Leaderboard.Builder

public interface LeaderboardOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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.
int	getPrevReset() The UNIX time when the leaderboard was previously reset.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getId

java.lang.String getId()

 The ID of the leaderboard.
 

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

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 The ID of the leaderboard.
 

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

Returns:

The bytes for id.

getSortOrder

int getSortOrder()

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

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

Returns:

The sortOrder.

getOperatorValue

int getOperatorValue()

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

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

Returns:

The enum numeric value on the wire for operator.

getOperator

Operator getOperator()

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

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

Returns:

The operator.

getPrevReset

int getPrevReset()

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

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

Returns:

The prevReset.

getNextReset

int getNextReset()

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

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

Returns:

The nextReset.

getMetadata

java.lang.String getMetadata()

 Additional information stored as a JSON object.
 

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

Returns:

The metadata.

getMetadataBytes

com.google.protobuf.ByteString getMetadataBytes()

 Additional information stored as a JSON object.
 

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

Returns:

The bytes for metadata.

hasCreateTime

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"];

Returns:

Whether the createTime field is set.

getCreateTime

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"];

Returns:

The createTime.

getCreateTimeOrBuilder

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"];

getAuthoritative

boolean getAuthoritative()

 Whether the leaderboard was created authoritatively or not.
 

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

Returns:

The authoritative.