games  v1
Public Member Functions | Static Public Member Functions | List of all members
google_games_api::AchievementUpdateRequest Class Reference

#include <achievement_update_request.h>

Inheritance diagram for google_games_api::AchievementUpdateRequest:

Public Member Functions

 AchievementUpdateRequest (const Json::Value &storage)
 
 AchievementUpdateRequest (Json::Value *storage)
 
virtual ~AchievementUpdateRequest ()
 
const StringPiece GetTypeName () const
 
bool has_achievement_id () const
 
void clear_achievement_id ()
 
const StringPiece get_achievement_id () const
 
void set_achievement_id (const StringPiece &value)
 
bool has_increment_payload () const
 
void clear_increment_payload ()
 
const GamesAchievementIncrement get_increment_payload () const
 
GamesAchievementIncrement mutable_incrementPayload ()
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_set_steps_at_least_payload () const
 
void clear_set_steps_at_least_payload ()
 
const GamesAchievementSetStepsAtLeast get_set_steps_at_least_payload () const
 
GamesAchievementSetStepsAtLeast mutable_setStepsAtLeastPayload ()
 
bool has_update_type () const
 
void clear_update_type ()
 
const StringPiece get_update_type () const
 
void set_update_type (const StringPiece &value)
 

Static Public Member Functions

static AchievementUpdateRequestNew ()
 

Detailed Description

This is a JSON template for a request to update an achievement.

Constructor & Destructor Documentation

◆ AchievementUpdateRequest() [1/2]

google_games_api::AchievementUpdateRequest::AchievementUpdateRequest ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ AchievementUpdateRequest() [2/2]

google_games_api::AchievementUpdateRequest::AchievementUpdateRequest ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~AchievementUpdateRequest()

google_games_api::AchievementUpdateRequest::~AchievementUpdateRequest ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_achievement_id()

void google_games_api::AchievementUpdateRequest::clear_achievement_id ( )
inline

Clears the 'achievementId' attribute.

◆ clear_increment_payload()

void google_games_api::AchievementUpdateRequest::clear_increment_payload ( )
inline

Clears the 'incrementPayload' attribute.

◆ clear_kind()

void google_games_api::AchievementUpdateRequest::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_set_steps_at_least_payload()

void google_games_api::AchievementUpdateRequest::clear_set_steps_at_least_payload ( )
inline

Clears the 'setStepsAtLeastPayload' attribute.

◆ clear_update_type()

void google_games_api::AchievementUpdateRequest::clear_update_type ( )
inline

Clears the 'updateType' attribute.

◆ get_achievement_id()

const StringPiece google_games_api::AchievementUpdateRequest::get_achievement_id ( ) const
inline

Get the value of the 'achievementId' attribute.

◆ get_increment_payload()

const GamesAchievementIncrement google_games_api::AchievementUpdateRequest::get_increment_payload ( ) const

Get a reference to the value of the 'incrementPayload' attribute.

◆ get_kind()

const StringPiece google_games_api::AchievementUpdateRequest::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_set_steps_at_least_payload()

const GamesAchievementSetStepsAtLeast google_games_api::AchievementUpdateRequest::get_set_steps_at_least_payload ( ) const

Get a reference to the value of the 'setStepsAtLeastPayload' attribute.

◆ get_update_type()

const StringPiece google_games_api::AchievementUpdateRequest::get_update_type ( ) const
inline

Get the value of the 'updateType' attribute.

◆ GetTypeName()

const StringPiece google_games_api::AchievementUpdateRequest::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_games_api::AchievementUpdateRequest

◆ has_achievement_id()

bool google_games_api::AchievementUpdateRequest::has_achievement_id ( ) const
inline

Determine if the 'achievementId' attribute was set.

Returns
true if the 'achievementId' attribute was set.

◆ has_increment_payload()

bool google_games_api::AchievementUpdateRequest::has_increment_payload ( ) const
inline

Determine if the 'incrementPayload' attribute was set.

Returns
true if the 'incrementPayload' attribute was set.

◆ has_kind()

bool google_games_api::AchievementUpdateRequest::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_set_steps_at_least_payload()

bool google_games_api::AchievementUpdateRequest::has_set_steps_at_least_payload ( ) const
inline

Determine if the 'setStepsAtLeastPayload' attribute was set.

Returns
true if the 'setStepsAtLeastPayload' attribute was set.

◆ has_update_type()

bool google_games_api::AchievementUpdateRequest::has_update_type ( ) const
inline

Determine if the 'updateType' attribute was set.

Returns
true if the 'updateType' attribute was set.

◆ mutable_incrementPayload()

GamesAchievementIncrement google_games_api::AchievementUpdateRequest::mutable_incrementPayload ( )

Gets a reference to a mutable value of the 'incrementPayload' property.

The payload if an update of type INCREMENT was requested for the achievement.

Returns
The result can be modified to change the attribute value.

◆ mutable_setStepsAtLeastPayload()

GamesAchievementSetStepsAtLeast google_games_api::AchievementUpdateRequest::mutable_setStepsAtLeastPayload ( )

Gets a reference to a mutable value of the 'setStepsAtLeastPayload' property.

The payload if an update of type SET_STEPS_AT_LEAST was requested for the achievement.

Returns
The result can be modified to change the attribute value.

◆ New()

AchievementUpdateRequest * google_games_api::AchievementUpdateRequest::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_achievement_id()

void google_games_api::AchievementUpdateRequest::set_achievement_id ( const StringPiece &  value)
inline

Change the 'achievementId' attribute.

The achievement this update is being applied to.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_games_api::AchievementUpdateRequest::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

Uniquely identifies the type of this resource. Value is always the fixed string games::achievementUpdateRequest.

Parameters
[in]valueThe new value.

◆ set_update_type()

void google_games_api::AchievementUpdateRequest::set_update_type ( const StringPiece &  value)
inline

Change the 'updateType' attribute.

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.
Parameters
[in]valueThe new value.

The documentation for this class was generated from the following files: