Class: Google::Apis::GamesV1::PlayerScore

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

Overview

This is a JSON template for a player score.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PlayerScore

Returns a new instance of PlayerScore.



2537
2538
2539
 
# File 'generated/google/apis/games_v1/classes.rb', line 2537

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

Instance Attribute Details

#formatted_score ⇒ String

The formatted score for this player score. Corresponds to the JSON property formattedScore

Returns:

  • (String) 


2509
2510
2511
 
# File 'generated/google/apis/games_v1/classes.rb', line 2509

def formatted_score
  @formatted_score
end

#kind ⇒ String

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

Returns:

  • (String) 


2515
2516
2517
 
# File 'generated/google/apis/games_v1/classes.rb', line 2515

def kind
  @kind
end

#score ⇒ Fixnum

The numerical value for this player score. Corresponds to the JSON property score

Returns:

  • (Fixnum) 


2520
2521
2522
 
# File 'generated/google/apis/games_v1/classes.rb', line 2520

def score
  @score
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) 


2526
2527
2528
 
# File 'generated/google/apis/games_v1/classes.rb', line 2526

def score_tag
  @score_tag
end

#time_span ⇒ String

The time span for this player score. Possible values are:

  • "ALL_TIME" - The score is an all-time score.
  • "WEEKLY" - The score is a weekly score.
  • "DAILY" - The score is a daily score. Corresponds to the JSON property timeSpan

Returns:

  • (String) 


2535
2536
2537
 
# File 'generated/google/apis/games_v1/classes.rb', line 2535

def time_span
  @time_span
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2542
2543
2544
2545
2546
2547
2548
 
# File 'generated/google/apis/games_v1/classes.rb', line 2542

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