com.heroiclabs.nakama.api

Interface ListLeaderboardRecordsRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

ListLeaderboardRecordsRequest, ListLeaderboardRecordsRequest.Builder

public interface ListLeaderboardRecordsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCursor() A next or previous page cursor.
com.google.protobuf.ByteString	getCursorBytes() A next or previous page cursor.
com.google.protobuf.Int64Value	getExpiry() Expiry in seconds (since epoch) to begin fetching records from.
com.google.protobuf.Int64ValueOrBuilder	getExpiryOrBuilder() Expiry in seconds (since epoch) to begin fetching records from.
java.lang.String	getLeaderboardId() The ID of the leaderboard to list for.
com.google.protobuf.ByteString	getLeaderboardIdBytes() The ID of the leaderboard to list for.
com.google.protobuf.Int32Value	getLimit() Max number of records to return.
com.google.protobuf.Int32ValueOrBuilder	getLimitOrBuilder() Max number of records to return.
java.lang.String	getOwnerIds(int index) One or more owners to retrieve records for.
com.google.protobuf.ByteString	getOwnerIdsBytes(int index) One or more owners to retrieve records for.
int	getOwnerIdsCount() One or more owners to retrieve records for.
java.util.List<java.lang.String>	getOwnerIdsList() One or more owners to retrieve records for.
boolean	hasExpiry() Expiry in seconds (since epoch) to begin fetching records from.
boolean	hasLimit() Max number of records to return.

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 to list for.
 

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

Returns:

The leaderboardId.

getLeaderboardIdBytes

com.google.protobuf.ByteString getLeaderboardIdBytes()

 The ID of the leaderboard to list for.
 

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

Returns:

The bytes for leaderboardId.

getOwnerIdsList

java.util.List<java.lang.String> getOwnerIdsList()

 One or more owners to retrieve records for.
 

repeated string owner_ids = 2 [json_name = "ownerIds"];

Returns:

A list containing the ownerIds.

getOwnerIdsCount

int getOwnerIdsCount()

 One or more owners to retrieve records for.
 

repeated string owner_ids = 2 [json_name = "ownerIds"];

Returns:

The count of ownerIds.

getOwnerIds

java.lang.String getOwnerIds(int index)

 One or more owners to retrieve records for.
 

repeated string owner_ids = 2 [json_name = "ownerIds"];

Parameters:

index - The index of the element to return.

Returns:

The ownerIds at the given index.

getOwnerIdsBytes

com.google.protobuf.ByteString getOwnerIdsBytes(int index)

 One or more owners to retrieve records for.
 

repeated string owner_ids = 2 [json_name = "ownerIds"];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the ownerIds at the given index.

hasLimit

boolean hasLimit()

 Max number of records to return. Between 1 and 100.
 

.google.protobuf.Int32Value limit = 3 [json_name = "limit"];

Returns:

Whether the limit field is set.

getLimit

com.google.protobuf.Int32Value getLimit()

 Max number of records to return. Between 1 and 100.
 

.google.protobuf.Int32Value limit = 3 [json_name = "limit"];

Returns:

The limit.

getLimitOrBuilder

com.google.protobuf.Int32ValueOrBuilder getLimitOrBuilder()

 Max number of records to return. Between 1 and 100.
 

.google.protobuf.Int32Value limit = 3 [json_name = "limit"];

getCursor

java.lang.String getCursor()

 A next or previous page cursor.
 

string cursor = 4 [json_name = "cursor"];

Returns:

The cursor.

getCursorBytes

com.google.protobuf.ByteString getCursorBytes()

 A next or previous page cursor.
 

string cursor = 4 [json_name = "cursor"];

Returns:

The bytes for cursor.

hasExpiry

boolean hasExpiry()

 Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
 

.google.protobuf.Int64Value expiry = 5 [json_name = "expiry"];

Returns:

Whether the expiry field is set.

getExpiry

com.google.protobuf.Int64Value getExpiry()

 Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
 

.google.protobuf.Int64Value expiry = 5 [json_name = "expiry"];

Returns:

The expiry.

getExpiryOrBuilder

com.google.protobuf.Int64ValueOrBuilder getExpiryOrBuilder()

 Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
 

.google.protobuf.Int64Value expiry = 5 [json_name = "expiry"];