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

#include <player_achievement.h>

Inheritance diagram for google_games_api::PlayerAchievement:

Public Member Functions

 PlayerAchievement (const Json::Value &storage)
 
 PlayerAchievement (Json::Value *storage)
 
virtual ~PlayerAchievement ()
 
const StringPiece GetTypeName () const
 
bool has_achievement_state () const
 
void clear_achievement_state ()
 
const StringPiece get_achievement_state () const
 
void set_achievement_state (const StringPiece &value)
 
bool has_current_steps () const
 
void clear_current_steps ()
 
int32 get_current_steps () const
 
void set_current_steps (int32 value)
 
bool has_experience_points () const
 
void clear_experience_points ()
 
int64 get_experience_points () const
 
void set_experience_points (int64 value)
 
bool has_formatted_current_steps_string () const
 
void clear_formatted_current_steps_string ()
 
const StringPiece get_formatted_current_steps_string () const
 
void set_formatted_current_steps_string (const StringPiece &value)
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_last_updated_timestamp () const
 
void clear_last_updated_timestamp ()
 
int64 get_last_updated_timestamp () const
 
void set_last_updated_timestamp (int64 value)
 

Static Public Member Functions

static PlayerAchievementNew ()
 

Detailed Description

This is a JSON template for an achievement object.

Constructor & Destructor Documentation

◆ PlayerAchievement() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ PlayerAchievement() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~PlayerAchievement()

google_games_api::PlayerAchievement::~PlayerAchievement ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_achievement_state()

void google_games_api::PlayerAchievement::clear_achievement_state ( )
inline

Clears the 'achievementState' attribute.

◆ clear_current_steps()

void google_games_api::PlayerAchievement::clear_current_steps ( )
inline

Clears the 'currentSteps' attribute.

◆ clear_experience_points()

void google_games_api::PlayerAchievement::clear_experience_points ( )
inline

Clears the 'experiencePoints' attribute.

◆ clear_formatted_current_steps_string()

void google_games_api::PlayerAchievement::clear_formatted_current_steps_string ( )
inline

Clears the 'formattedCurrentStepsString' attribute.

◆ clear_id()

void google_games_api::PlayerAchievement::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_games_api::PlayerAchievement::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_last_updated_timestamp()

void google_games_api::PlayerAchievement::clear_last_updated_timestamp ( )
inline

Clears the 'lastUpdatedTimestamp' attribute.

◆ get_achievement_state()

const StringPiece google_games_api::PlayerAchievement::get_achievement_state ( ) const
inline

Get the value of the 'achievementState' attribute.

◆ get_current_steps()

int32 google_games_api::PlayerAchievement::get_current_steps ( ) const
inline

Get the value of the 'currentSteps' attribute.

◆ get_experience_points()

int64 google_games_api::PlayerAchievement::get_experience_points ( ) const
inline

Get the value of the 'experiencePoints' attribute.

◆ get_formatted_current_steps_string()

const StringPiece google_games_api::PlayerAchievement::get_formatted_current_steps_string ( ) const
inline

Get the value of the 'formattedCurrentStepsString' attribute.

◆ get_id()

const StringPiece google_games_api::PlayerAchievement::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_last_updated_timestamp()

int64 google_games_api::PlayerAchievement::get_last_updated_timestamp ( ) const
inline

Get the value of the 'lastUpdatedTimestamp' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_games_api::PlayerAchievement

◆ has_achievement_state()

bool google_games_api::PlayerAchievement::has_achievement_state ( ) const
inline

Determine if the 'achievementState' attribute was set.

Returns
true if the 'achievementState' attribute was set.

◆ has_current_steps()

bool google_games_api::PlayerAchievement::has_current_steps ( ) const
inline

Determine if the 'currentSteps' attribute was set.

Returns
true if the 'currentSteps' attribute was set.

◆ has_experience_points()

bool google_games_api::PlayerAchievement::has_experience_points ( ) const
inline

Determine if the 'experiencePoints' attribute was set.

Returns
true if the 'experiencePoints' attribute was set.

◆ has_formatted_current_steps_string()

bool google_games_api::PlayerAchievement::has_formatted_current_steps_string ( ) const
inline

Determine if the 'formattedCurrentStepsString' attribute was set.

Returns
true if the 'formattedCurrentStepsString' attribute was set.

◆ has_id()

bool google_games_api::PlayerAchievement::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_kind()

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

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_last_updated_timestamp()

bool google_games_api::PlayerAchievement::has_last_updated_timestamp ( ) const
inline

Determine if the 'lastUpdatedTimestamp' attribute was set.

Returns
true if the 'lastUpdatedTimestamp' attribute was set.

◆ New()

PlayerAchievement * google_games_api::PlayerAchievement::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_achievement_state()

void google_games_api::PlayerAchievement::set_achievement_state ( const StringPiece &  value)
inline

Change the 'achievementState' attribute.

The state of the achievement. Possible values are:

"HIDDEN"
Achievement is hidden.
"REVEALED"
Achievement is revealed.
"UNLOCKED"
Achievement is unlocked.
Parameters
[in]valueThe new value.

◆ set_current_steps()

void google_games_api::PlayerAchievement::set_current_steps ( int32  value)
inline

Change the 'currentSteps' attribute.

The current steps for an incremental achievement.

Parameters
[in]valueThe new value.

◆ set_experience_points()

void google_games_api::PlayerAchievement::set_experience_points ( int64  value)
inline

Change the 'experiencePoints' attribute.

Experience points earned for the achievement. This field is absent for achievements that have not yet been unlocked and 0 for achievements that have been unlocked by testers but that are unpublished.

Parameters
[in]valueThe new value.

◆ set_formatted_current_steps_string()

void google_games_api::PlayerAchievement::set_formatted_current_steps_string ( const StringPiece &  value)
inline

Change the 'formattedCurrentStepsString' attribute.

The current steps for an incremental achievement as a string.

Parameters
[in]valueThe new value.

◆ set_id()

void google_games_api::PlayerAchievement::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

The ID of the achievement.

Parameters
[in]valueThe new value.

◆ set_kind()

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

Change the 'kind' attribute.

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

Parameters
[in]valueThe new value.

◆ set_last_updated_timestamp()

void google_games_api::PlayerAchievement::set_last_updated_timestamp ( int64  value)
inline

Change the 'lastUpdatedTimestamp' attribute.

The timestamp of the last modification to this achievement's state.

Parameters
[in]valueThe new value.

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