com.heroiclabs.nakama.api

Interface LeaderboardRecordOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

LeaderboardRecord, LeaderboardRecord.Builder

public interface LeaderboardRecordOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Timestamp	getCreateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was created.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was created.
com.google.protobuf.Timestamp	getExpiryTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record expires.
com.google.protobuf.TimestampOrBuilder	getExpiryTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record expires.
java.lang.String	getLeaderboardId() The ID of the leaderboard this score belongs to.
com.google.protobuf.ByteString	getLeaderboardIdBytes() The ID of the leaderboard this score belongs to.
int	getMaxNumScore() The maximum number of score updates allowed by the owner.
java.lang.String	getMetadata() Metadata.
com.google.protobuf.ByteString	getMetadataBytes() Metadata.
int	getNumScore() The number of submissions to this score record.
java.lang.String	getOwnerId() The ID of the score owner, usually a user or group.
com.google.protobuf.ByteString	getOwnerIdBytes() The ID of the score owner, usually a user or group.
long	getRank() The rank of this record.
long	getScore() The score value.
long	getSubscore() An optional subscore value.
com.google.protobuf.Timestamp	getUpdateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was updated.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was updated.
com.google.protobuf.StringValue	getUsername() The username of the score owner, if the owner is a user.
com.google.protobuf.StringValueOrBuilder	getUsernameOrBuilder() The username of the score owner, if the owner is a user.
boolean	hasCreateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was created.
boolean	hasExpiryTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record expires.
boolean	hasUpdateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was updated.
boolean	hasUsername() The username of the score owner, if the owner is a user.

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

getLeaderboardId

java.lang.String getLeaderboardId()

 The ID of the leaderboard this score belongs to.
 

string leaderboard_id = 1 [json_name = "leaderboardId"];

Returns:

The leaderboardId.

getLeaderboardIdBytes

com.google.protobuf.ByteString getLeaderboardIdBytes()

 The ID of the leaderboard this score belongs to.
 

string leaderboard_id = 1 [json_name = "leaderboardId"];

Returns:

The bytes for leaderboardId.

getOwnerId

java.lang.String getOwnerId()

 The ID of the score owner, usually a user or group.
 

string owner_id = 2 [json_name = "ownerId"];

Returns:

The ownerId.

getOwnerIdBytes

com.google.protobuf.ByteString getOwnerIdBytes()

 The ID of the score owner, usually a user or group.
 

string owner_id = 2 [json_name = "ownerId"];

Returns:

The bytes for ownerId.

hasUsername

boolean hasUsername()

 The username of the score owner, if the owner is a user.
 

.google.protobuf.StringValue username = 3 [json_name = "username"];

Returns:

Whether the username field is set.

getUsername

com.google.protobuf.StringValue getUsername()

 The username of the score owner, if the owner is a user.
 

.google.protobuf.StringValue username = 3 [json_name = "username"];

Returns:

The username.

getUsernameOrBuilder

com.google.protobuf.StringValueOrBuilder getUsernameOrBuilder()

 The username of the score owner, if the owner is a user.
 

.google.protobuf.StringValue username = 3 [json_name = "username"];

getScore

long getScore()

 The score value.
 

int64 score = 4 [json_name = "score"];

Returns:

The score.

getSubscore

long getSubscore()

 An optional subscore value.
 

int64 subscore = 5 [json_name = "subscore"];

Returns:

The subscore.

getNumScore

int getNumScore()

 The number of submissions to this score record.
 

int32 num_score = 6 [json_name = "numScore"];

Returns:

The numScore.

getMetadata

java.lang.String getMetadata()

 Metadata.
 

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

Returns:

The metadata.

getMetadataBytes

com.google.protobuf.ByteString getMetadataBytes()

 Metadata.
 

string metadata = 7 [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 record was created.
 

.google.protobuf.Timestamp create_time = 8 [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 record was created.
 

.google.protobuf.Timestamp create_time = 8 [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 record was created.
 

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

hasUpdateTime

boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 9 [json_name = "updateTime"];

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 9 [json_name = "updateTime"];

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 9 [json_name = "updateTime"];

hasExpiryTime

boolean hasExpiryTime()

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

.google.protobuf.Timestamp expiry_time = 10 [json_name = "expiryTime"];

Returns:

Whether the expiryTime field is set.

getExpiryTime

com.google.protobuf.Timestamp getExpiryTime()

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

.google.protobuf.Timestamp expiry_time = 10 [json_name = "expiryTime"];

Returns:

The expiryTime.

getExpiryTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getExpiryTimeOrBuilder()

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

.google.protobuf.Timestamp expiry_time = 10 [json_name = "expiryTime"];

getRank

long getRank()

 The rank of this record.
 

int64 rank = 11 [json_name = "rank"];

Returns:

The rank.

getMaxNumScore

int getMaxNumScore()

 The maximum number of score updates allowed by the owner.
 

uint32 max_num_score = 12 [json_name = "maxNumScore"];

Returns:

The maxNumScore.