Class: Google::Apis::GamesV1::PlayerLeaderboardScore

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/games_v1/classes.rb,
lib/google/apis/games_v1/representations.rb,
lib/google/apis/games_v1/representations.rb

Overview

A player leaderboard score object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PlayerLeaderboardScore

Returns a new instance of PlayerLeaderboardScore.



2155
2156
2157
 
# File 'lib/google/apis/games_v1/classes.rb', line 2155

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#friends_rank ⇒ Google::Apis::GamesV1::LeaderboardScoreRank

A score rank in a leaderboard. Corresponds to the JSON property friendsRank

Returns:



2105
2106
2107
 
# File 'lib/google/apis/games_v1/classes.rb', line 2105

def friends_rank
  @friends_rank
end

#kind ⇒ String

Uniquely identifies the type of this resource. Value is always the fixed string games#playerLeaderboardScore. Corresponds to the JSON property kind

Returns:

  • (String) 


2111
2112
2113
 
# File 'lib/google/apis/games_v1/classes.rb', line 2111

def kind
  @kind
end

#leaderboard_id ⇒ String

The ID of the leaderboard this score is in. Corresponds to the JSON property leaderboard_id

Returns:

  • (String) 


2116
2117
2118
 
# File 'lib/google/apis/games_v1/classes.rb', line 2116

def leaderboard_id
  @leaderboard_id
end

#public_rank ⇒ Google::Apis::GamesV1::LeaderboardScoreRank

A score rank in a leaderboard. Corresponds to the JSON property publicRank

Returns:



2121
2122
2123
 
# File 'lib/google/apis/games_v1/classes.rb', line 2121

def public_rank
  @public_rank
end

#score_string ⇒ String

The formatted value of this score. Corresponds to the JSON property scoreString

Returns:

  • (String) 


2126
2127
2128
 
# File 'lib/google/apis/games_v1/classes.rb', line 2126

def score_string
  @score_string
end

#score_tag ⇒ String

Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. Corresponds to the JSON property scoreTag

Returns:

  • (String) 


2132
2133
2134
 
# File 'lib/google/apis/games_v1/classes.rb', line 2132

def score_tag
  @score_tag
end

#score_value ⇒ Fixnum

The numerical value of this score. Corresponds to the JSON property scoreValue

Returns:

  • (Fixnum) 


2137
2138
2139
 
# File 'lib/google/apis/games_v1/classes.rb', line 2137

def score_value
  @score_value
end

#social_rank ⇒ Google::Apis::GamesV1::LeaderboardScoreRank

A score rank in a leaderboard. Corresponds to the JSON property socialRank

Returns:



2142
2143
2144
 
# File 'lib/google/apis/games_v1/classes.rb', line 2142

def social_rank
  @social_rank
end

#time_span ⇒ String

The time span of this score. Corresponds to the JSON property timeSpan

Returns:

  • (String) 


2147
2148
2149
 
# File 'lib/google/apis/games_v1/classes.rb', line 2147

def time_span
  @time_span
end

#write_timestamp ⇒ Fixnum

The timestamp at which this score was recorded, in milliseconds since the epoch in UTC. Corresponds to the JSON property writeTimestamp

Returns:

  • (Fixnum) 


2153
2154
2155
 
# File 'lib/google/apis/games_v1/classes.rb', line 2153

def write_timestamp
  @write_timestamp
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'lib/google/apis/games_v1/classes.rb', line 2160

def update!(**args)
  @friends_rank = args[:friends_rank] if args.key?(:friends_rank)
  @kind = args[:kind] if args.key?(:kind)
  @leaderboard_id = args[:leaderboard_id] if args.key?(:leaderboard_id)
  @public_rank = args[:public_rank] if args.key?(:public_rank)
  @score_string = args[:score_string] if args.key?(:score_string)
  @score_tag = args[:score_tag] if args.key?(:score_tag)
  @score_value = args[:score_value] if args.key?(:score_value)
  @social_rank = args[:social_rank] if args.key?(:social_rank)
  @time_span = args[:time_span] if args.key?(:time_span)
  @write_timestamp = args[:write_timestamp] if args.key?(:write_timestamp)
end