Class: Google::Apis::GamesV1::PlayerScoreResponse

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 list of leaderboard entry resources.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PlayerScoreResponse

Returns a new instance of PlayerScoreResponse.



2287
2288
2289
 
# File 'lib/google/apis/games_v1/classes.rb', line 2287

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

Instance Attribute Details

#beaten_score_time_spans ⇒ Array<String>

The time spans where the submitted score is better than the existing score for that time span. Corresponds to the JSON property beatenScoreTimeSpans

Returns:

  • (Array<String>) 


2256
2257
2258
 
# File 'lib/google/apis/games_v1/classes.rb', line 2256

def beaten_score_time_spans
  @beaten_score_time_spans
end

#formatted_score ⇒ String

The formatted value of the submitted score. Corresponds to the JSON property formattedScore

Returns:

  • (String) 


2261
2262
2263
 
# File 'lib/google/apis/games_v1/classes.rb', line 2261

def formatted_score
  @formatted_score
end

#kind ⇒ String

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

Returns:

  • (String) 


2267
2268
2269
 
# File 'lib/google/apis/games_v1/classes.rb', line 2267

def kind
  @kind
end

#leaderboard_id ⇒ String

The leaderboard ID that this score was submitted to. Corresponds to the JSON property leaderboardId

Returns:

  • (String) 


2272
2273
2274
 
# File 'lib/google/apis/games_v1/classes.rb', line 2272

def leaderboard_id
  @leaderboard_id
end

#score_tag ⇒ String

Additional information about this score. Values will 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) 


2278
2279
2280
 
# File 'lib/google/apis/games_v1/classes.rb', line 2278

def score_tag
  @score_tag
end

#unbeaten_scores ⇒ Array<Google::Apis::GamesV1::PlayerScore>

The scores in time spans that have not been beaten. As an example, the submitted score may be better than the player's DAILY score, but not better than the player's scores for the WEEKLY or ALL_TIME time spans. Corresponds to the JSON property unbeatenScores

Returns:



2285
2286
2287
 
# File 'lib/google/apis/games_v1/classes.rb', line 2285

def unbeaten_scores
  @unbeaten_scores
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2292
2293
2294
2295
2296
2297
2298
2299
 
# File 'lib/google/apis/games_v1/classes.rb', line 2292

def update!(**args)
  @beaten_score_time_spans = args[:beaten_score_time_spans] if args.key?(:beaten_score_time_spans)
  @formatted_score = args[:formatted_score] if args.key?(:formatted_score)
  @kind = args[:kind] if args.key?(:kind)
  @leaderboard_id = args[:leaderboard_id] if args.key?(:leaderboard_id)
  @score_tag = args[:score_tag] if args.key?(:score_tag)
  @unbeaten_scores = args[:unbeaten_scores] if args.key?(:unbeaten_scores)
end