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.



2449
2450
2451
 
# File 'lib/google/apis/games_v1/classes.rb', line 2449

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>) 


2418
2419
2420
 
# File 'lib/google/apis/games_v1/classes.rb', line 2418

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) 


2423
2424
2425
 
# File 'lib/google/apis/games_v1/classes.rb', line 2423

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) 


2429
2430
2431
 
# File 'lib/google/apis/games_v1/classes.rb', line 2429

def kind
  @kind
end

#leaderboard_id ⇒ String

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

Returns:

  • (String) 


2434
2435
2436
 
# File 'lib/google/apis/games_v1/classes.rb', line 2434

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) 


2440
2441
2442
 
# File 'lib/google/apis/games_v1/classes.rb', line 2440

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:



2447
2448
2449
 
# File 'lib/google/apis/games_v1/classes.rb', line 2447

def unbeaten_scores
  @unbeaten_scores
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2454
2455
2456
2457
2458
2459
2460
2461
 
# File 'lib/google/apis/games_v1/classes.rb', line 2454

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