Package 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 TypeMethodDescriptionA next or previous page cursor.com.google.protobuf.ByteString
A next or previous page cursor.Expiry in seconds (since epoch) to begin fetching records from.Expiry in seconds (since epoch) to begin fetching records from.The ID of the leaderboard to list for.com.google.protobuf.ByteString
The ID of the leaderboard to list for.getLimit()
Max number of records to return.Max number of records to return.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
One or more owners to retrieve records for.One or more owners to retrieve records for.boolean
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.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getLeaderboardId
String getLeaderboardId()The ID of the leaderboard to list for.
string leaderboard_id = 1;
- Returns:
- The leaderboardId.
-
getLeaderboardIdBytes
com.google.protobuf.ByteString getLeaderboardIdBytes()The ID of the leaderboard to list for.
string leaderboard_id = 1;
- Returns:
- The bytes for leaderboardId.
-
getOwnerIdsList
One or more owners to retrieve records for.
repeated string owner_ids = 2;
- Returns:
- A list containing the ownerIds.
-
getOwnerIdsCount
int getOwnerIdsCount()One or more owners to retrieve records for.
repeated string owner_ids = 2;
- Returns:
- The count of ownerIds.
-
getOwnerIds
One or more owners to retrieve records for.
repeated string owner_ids = 2;
- 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;
- 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;
- Returns:
- Whether the limit field is set.
-
getLimit
Int32Value getLimit()Max number of records to return. Between 1 and 100.
.google.protobuf.Int32Value limit = 3;
- Returns:
- The limit.
-
getLimitOrBuilder
Int32ValueOrBuilder getLimitOrBuilder()Max number of records to return. Between 1 and 100.
.google.protobuf.Int32Value limit = 3;
-
getCursor
String getCursor()A next or previous page cursor.
string cursor = 4;
- Returns:
- The cursor.
-
getCursorBytes
com.google.protobuf.ByteString getCursorBytes()A next or previous page cursor.
string cursor = 4;
- 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;
- Returns:
- Whether the expiry field is set.
-
getExpiry
Int64Value getExpiry()Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
.google.protobuf.Int64Value expiry = 5;
- Returns:
- The expiry.
-
getExpiryOrBuilder
Int64ValueOrBuilder getExpiryOrBuilder()Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
.google.protobuf.Int64Value expiry = 5;
-