Package 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 Details

    • getLeaderboardId

      String getLeaderboardId()
       The ID of the leaderboard this score belongs to.
      string leaderboard_id = 1;
      Returns:
      The leaderboardId.

    • getLeaderboardIdBytes

      com.google.protobuf.ByteString getLeaderboardIdBytes()
       The ID of the leaderboard this score belongs to.
      string leaderboard_id = 1;
      Returns:
      The bytes for leaderboardId.

    • getOwnerId

      String getOwnerId()
       The ID of the score owner, usually a user or group.
      string owner_id = 2;
      Returns:
      The ownerId.

    • getOwnerIdBytes

      com.google.protobuf.ByteString getOwnerIdBytes()
       The ID of the score owner, usually a user or group.
      string owner_id = 2;
      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;
      Returns:
      Whether the username field is set.

    • getUsername

      StringValue getUsername()
       The username of the score owner, if the owner is a user.
      .google.protobuf.StringValue username = 3;
      Returns:
      The username.

    • getUsernameOrBuilder

      StringValueOrBuilder getUsernameOrBuilder()
       The username of the score owner, if the owner is a user.
      .google.protobuf.StringValue username = 3;

    • getScore

      long getScore()
       The score value.
      int64 score = 4;
      Returns:
      The score.

    • getSubscore

      long getSubscore()
       An optional subscore value.
      int64 subscore = 5;
      Returns:
      The subscore.

    • getNumScore

      int getNumScore()
       The number of submissions to this score record.
      int32 num_score = 6;
      Returns:
      The numScore.

    • getMetadata

      String getMetadata()
       Metadata.
      string metadata = 7;
      Returns:
      The metadata.

    • getMetadataBytes

      com.google.protobuf.ByteString getMetadataBytes()
       Metadata.
      string metadata = 7;
      Returns:
      The bytes for metadata.

    • hasCreateTime

      boolean hasCreateTime()
       The UNIX time when the leaderboard record was created.
      .google.protobuf.Timestamp create_time = 8;
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      Timestamp getCreateTime()
       The UNIX time when the leaderboard record was created.
      .google.protobuf.Timestamp create_time = 8;
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      TimestampOrBuilder getCreateTimeOrBuilder()
       The UNIX time when the leaderboard record was created.
      .google.protobuf.Timestamp create_time = 8;

    • hasUpdateTime

      boolean hasUpdateTime()
       The UNIX time when the leaderboard record was updated.
      .google.protobuf.Timestamp update_time = 9;
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      Timestamp getUpdateTime()
       The UNIX time when the leaderboard record was updated.
      .google.protobuf.Timestamp update_time = 9;
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      TimestampOrBuilder getUpdateTimeOrBuilder()
       The UNIX time when the leaderboard record was updated.
      .google.protobuf.Timestamp update_time = 9;

    • hasExpiryTime

      boolean hasExpiryTime()
       The UNIX time when the leaderboard record expires.
      .google.protobuf.Timestamp expiry_time = 10;
      Returns:
      Whether the expiryTime field is set.

    • getExpiryTime

      Timestamp getExpiryTime()
       The UNIX time when the leaderboard record expires.
      .google.protobuf.Timestamp expiry_time = 10;
      Returns:
      The expiryTime.

    • getExpiryTimeOrBuilder

      TimestampOrBuilder getExpiryTimeOrBuilder()
       The UNIX time when the leaderboard record expires.
      .google.protobuf.Timestamp expiry_time = 10;

    • getRank

      long getRank()
       The rank of this record.
      int64 rank = 11;
      Returns:
      The rank.

    • getMaxNumScore

      int getMaxNumScore()
       The maximum number of score updates allowed by the owner.
      uint32 max_num_score = 12;
      Returns:
      The maxNumScore.