RankingVariant class

A class that includes the score information of the current player on the leaderboard in a specified time frame

Constructors

RankingVariant({String? displayRanking, String? playerDisplayScore, int? rankTotalScoreNum, int? playerRank, String? playerScoreTips, int? playerRawScore, int? timeDimension, bool? hasPlayerInfo})
RankingVariant.fromMap(Map map)
factory

Properties

displayRanking ↔ String?
Indicates the localized number corresponding to a player's rank to be displayed. The number is returned only when hasPlayerInfo field is true.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
hasPlayerInfo ↔ bool?
Indicates whether the current player exists on the leaderboard.
getter/setter pair
playerDisplayScore ↔ String?
Indicates the localized number corresponding to a player's score to be displayed. The number is returned only when hasPlayerInfo field is true.
getter/setter pair
playerRank ↔ int?
Indicates the player's rank on a leaderboard. The number is returned only when hasPlayerInfo field is true.
getter/setter pair
playerRawScore ↔ int?
Raw score of a player. The number is returned only when hasPlayerInfo field is true.
getter/setter pair
playerScoreTips ↔ String?
Custom unit for a player's score. The number is returned only when hasPlayerInfo field is true.
getter/setter pair
rankTotalScoreNum ↔ int?
Total score on a leaderboard.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
timeDimension ↔ int?
Time frame. The options are as follows: 0: daily 1: weekly 2: all-time
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

NUM_SCORES_UNKNOWN → const int
Unknown total score on a leaderboard.
NUM_TIME_DIMENSION → const int
Number of time frames of a leaderboard.
PLAYER_RANK_UNKNOWN → const int
Unknown rank of a player on a leaderboard.
PLAYER_SCORE_UNKNOWN → const int
Unknown score of a player.
TIME_DIMENSION_ALL_TIME → const int
All-time leaderboard.
TIME_DIMENSION_DAILY → const int
Daily leaderboard.
TIME_DIMENSION_WEEKLY → const int
Weekly leaderboard.