Class: Google::Apis::GamesV1::UpdateAchievementRequest

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 request to update an achievement.

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

Returns a new instance of UpdateAchievementRequest.



374
375
376
 
# File 'generated/google/apis/games_v1/classes.rb', line 374

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

Instance Attribute Details

#achievement_id ⇒ String

The achievement this update is being applied to. Corresponds to the JSON property achievementId

Returns:

  • (String) 


345
346
347
 
# File 'generated/google/apis/games_v1/classes.rb', line 345

def achievement_id
  @achievement_id
end

#increment_payload ⇒ Google::Apis::GamesV1::GamesAchievementIncrement

This is a JSON template for the payload to request to increment an achievement. Corresponds to the JSON property incrementPayload

Returns:



350
351
352
 
# File 'generated/google/apis/games_v1/classes.rb', line 350

def increment_payload
  @increment_payload
end

#kind ⇒ String

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

Returns:

  • (String) 


356
357
358
 
# File 'generated/google/apis/games_v1/classes.rb', line 356

def kind
  @kind
end

#set_steps_at_least_payload ⇒ Google::Apis::GamesV1::GamesAchievementSetStepsAtLeast

This is a JSON template for the payload to request to increment an achievement. Corresponds to the JSON property setStepsAtLeastPayload

Returns:



361
362
363
 
# File 'generated/google/apis/games_v1/classes.rb', line 361

def set_steps_at_least_payload
  @set_steps_at_least_payload
end

#update_type ⇒ String

The type of update being applied. Possible values are:

  • "REVEAL" - Achievement is revealed.
  • "UNLOCK" - Achievement is unlocked.
  • "INCREMENT" - Achievement is incremented.
  • "SET_STEPS_AT_LEAST" - Achievement progress is set to at least the passed value. Corresponds to the JSON property updateType

Returns:

  • (String) 


372
373
374
 
# File 'generated/google/apis/games_v1/classes.rb', line 372

def update_type
  @update_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



379
380
381
382
383
384
385
 
# File 'generated/google/apis/games_v1/classes.rb', line 379

def update!(**args)
  @achievement_id = args[:achievement_id] if args.key?(:achievement_id)
  @increment_payload = args[:increment_payload] if args.key?(:increment_payload)
  @kind = args[:kind] if args.key?(:kind)
  @set_steps_at_least_payload = args[:set_steps_at_least_payload] if args.key?(:set_steps_at_least_payload)
  @update_type = args[:update_type] if args.key?(:update_type)
end