#include <achievement_definition.h>

Inheritance diagram for google_games_api::AchievementDefinition:

Public Member Functions
	AchievementDefinition (const Json::Value &storage)

	AchievementDefinition (Json::Value *storage)

virtual	~AchievementDefinition ()

const StringPiece	GetTypeName () const

bool	has_achievement_type () const

void	clear_achievement_type ()

const StringPiece	get_achievement_type () const

void	set_achievement_type (const StringPiece &value)

bool	has_description () const

void	clear_description ()

const StringPiece	get_description () const

void	set_description (const StringPiece &value)

bool	has_experience_points () const

void	clear_experience_points ()

int64	get_experience_points () const

void	set_experience_points (int64 value)

bool	has_formatted_total_steps () const

void	clear_formatted_total_steps ()

const StringPiece	get_formatted_total_steps () const

void	set_formatted_total_steps (const StringPiece &value)

bool	has_id () const

void	clear_id ()

const StringPiece	get_id () const

void	set_id (const StringPiece &value)

bool	has_initial_state () const

void	clear_initial_state ()

const StringPiece	get_initial_state () const

void	set_initial_state (const StringPiece &value)

bool	has_is_revealed_icon_url_default () const

void	clear_is_revealed_icon_url_default ()

bool	get_is_revealed_icon_url_default () const

void	set_is_revealed_icon_url_default (bool value)

bool	has_is_unlocked_icon_url_default () const

void	clear_is_unlocked_icon_url_default ()

bool	get_is_unlocked_icon_url_default () const

void	set_is_unlocked_icon_url_default (bool value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_name () const

void	clear_name ()

const StringPiece	get_name () const

void	set_name (const StringPiece &value)

bool	has_revealed_icon_url () const

void	clear_revealed_icon_url ()

const StringPiece	get_revealed_icon_url () const

void	set_revealed_icon_url (const StringPiece &value)

bool	has_total_steps () const

void	clear_total_steps ()

int32	get_total_steps () const

void	set_total_steps (int32 value)

bool	has_unlocked_icon_url () const

void	clear_unlocked_icon_url ()

const StringPiece	get_unlocked_icon_url () const

void	set_unlocked_icon_url (const StringPiece &value)

Static Public Member Functions
static AchievementDefinition *	New ()

Detailed Description

This is a JSON template for an achievement definition object.

Constructor & Destructor Documentation

◆ AchievementDefinition() [1/2]

google_games_api::AchievementDefinition::AchievementDefinition ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ AchievementDefinition() [2/2]

google_games_api::AchievementDefinition::AchievementDefinition ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~AchievementDefinition()

google_games_api::AchievementDefinition::~AchievementDefinition ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_achievement_type()

void google_games_api::AchievementDefinition::clear_achievement_type ( )

inline

Clears the 'achievementType' attribute.

◆ clear_description()

void google_games_api::AchievementDefinition::clear_description ( )

inline

Clears the 'description' attribute.

◆ clear_experience_points()

void google_games_api::AchievementDefinition::clear_experience_points ( )

inline

Clears the 'experiencePoints' attribute.

◆ clear_formatted_total_steps()

void google_games_api::AchievementDefinition::clear_formatted_total_steps ( )

inline

Clears the 'formattedTotalSteps' attribute.

◆ clear_id()

void google_games_api::AchievementDefinition::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_initial_state()

void google_games_api::AchievementDefinition::clear_initial_state ( )

inline

Clears the 'initialState' attribute.

◆ clear_is_revealed_icon_url_default()

void google_games_api::AchievementDefinition::clear_is_revealed_icon_url_default ( )

inline

Clears the 'isRevealedIconUrlDefault' attribute.

◆ clear_is_unlocked_icon_url_default()

void google_games_api::AchievementDefinition::clear_is_unlocked_icon_url_default ( )

inline

Clears the 'isUnlockedIconUrlDefault' attribute.

◆ clear_kind()

void google_games_api::AchievementDefinition::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_name()

void google_games_api::AchievementDefinition::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_revealed_icon_url()

void google_games_api::AchievementDefinition::clear_revealed_icon_url ( )

inline

Clears the 'revealedIconUrl' attribute.

◆ clear_total_steps()

void google_games_api::AchievementDefinition::clear_total_steps ( )

inline

Clears the 'totalSteps' attribute.

◆ clear_unlocked_icon_url()

void google_games_api::AchievementDefinition::clear_unlocked_icon_url ( )

inline

Clears the 'unlockedIconUrl' attribute.

◆ get_achievement_type()

const StringPiece google_games_api::AchievementDefinition::get_achievement_type ( ) const

inline

Get the value of the 'achievementType' attribute.

◆ get_description()

const StringPiece google_games_api::AchievementDefinition::get_description ( ) const

inline

Get the value of the 'description' attribute.

◆ get_experience_points()

int64 google_games_api::AchievementDefinition::get_experience_points ( ) const

inline

Get the value of the 'experiencePoints' attribute.

◆ get_formatted_total_steps()

const StringPiece google_games_api::AchievementDefinition::get_formatted_total_steps ( ) const

inline

Get the value of the 'formattedTotalSteps' attribute.

◆ get_id()

const StringPiece google_games_api::AchievementDefinition::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_initial_state()

const StringPiece google_games_api::AchievementDefinition::get_initial_state ( ) const

inline

Get the value of the 'initialState' attribute.

◆ get_is_revealed_icon_url_default()

bool google_games_api::AchievementDefinition::get_is_revealed_icon_url_default ( ) const

inline

Get the value of the 'isRevealedIconUrlDefault' attribute.

◆ get_is_unlocked_icon_url_default()

bool google_games_api::AchievementDefinition::get_is_unlocked_icon_url_default ( ) const

inline

Get the value of the 'isUnlockedIconUrlDefault' attribute.

◆ get_kind()

const StringPiece google_games_api::AchievementDefinition::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_name()

const StringPiece google_games_api::AchievementDefinition::get_name ( ) const

inline

Get the value of the 'name' attribute.

◆ get_revealed_icon_url()

const StringPiece google_games_api::AchievementDefinition::get_revealed_icon_url ( ) const

inline

Get the value of the 'revealedIconUrl' attribute.

◆ get_total_steps()

int32 google_games_api::AchievementDefinition::get_total_steps ( ) const

inline

Get the value of the 'totalSteps' attribute.

◆ get_unlocked_icon_url()

const StringPiece google_games_api::AchievementDefinition::get_unlocked_icon_url ( ) const

inline

Get the value of the 'unlockedIconUrl' attribute.

◆ GetTypeName()

const StringPiece google_games_api::AchievementDefinition::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_games_api::AchievementDefinition

◆ has_achievement_type()

bool google_games_api::AchievementDefinition::has_achievement_type ( ) const

inline

Determine if the 'achievementType' attribute was set.

Returns: true if the 'achievementType' attribute was set.

◆ has_description()

bool google_games_api::AchievementDefinition::has_description ( ) const

inline

Determine if the 'description' attribute was set.

Returns: true if the 'description' attribute was set.

◆ has_experience_points()

bool google_games_api::AchievementDefinition::has_experience_points ( ) const

inline

Determine if the 'experiencePoints' attribute was set.

Returns: true if the 'experiencePoints' attribute was set.

◆ has_formatted_total_steps()

bool google_games_api::AchievementDefinition::has_formatted_total_steps ( ) const

inline

Determine if the 'formattedTotalSteps' attribute was set.

Returns: true if the 'formattedTotalSteps' attribute was set.

◆ has_id()

bool google_games_api::AchievementDefinition::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns: true if the 'id' attribute was set.

◆ has_initial_state()

bool google_games_api::AchievementDefinition::has_initial_state ( ) const

inline

Determine if the 'initialState' attribute was set.

Returns: true if the 'initialState' attribute was set.

◆ has_is_revealed_icon_url_default()

bool google_games_api::AchievementDefinition::has_is_revealed_icon_url_default ( ) const

inline

Determine if the 'isRevealedIconUrlDefault' attribute was set.

Returns: true if the 'isRevealedIconUrlDefault' attribute was set.

◆ has_is_unlocked_icon_url_default()

bool google_games_api::AchievementDefinition::has_is_unlocked_icon_url_default ( ) const

inline

Determine if the 'isUnlockedIconUrlDefault' attribute was set.

Returns: true if the 'isUnlockedIconUrlDefault' attribute was set.

◆ has_kind()

bool google_games_api::AchievementDefinition::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_name()

bool google_games_api::AchievementDefinition::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns: true if the 'name' attribute was set.

◆ has_revealed_icon_url()

bool google_games_api::AchievementDefinition::has_revealed_icon_url ( ) const

inline

Determine if the 'revealedIconUrl' attribute was set.

Returns: true if the 'revealedIconUrl' attribute was set.

◆ has_total_steps()

bool google_games_api::AchievementDefinition::has_total_steps ( ) const

inline

Determine if the 'totalSteps' attribute was set.

Returns: true if the 'totalSteps' attribute was set.

◆ has_unlocked_icon_url()

bool google_games_api::AchievementDefinition::has_unlocked_icon_url ( ) const

inline

Determine if the 'unlockedIconUrl' attribute was set.

Returns: true if the 'unlockedIconUrl' attribute was set.

◆ New()

AchievementDefinition * google_games_api::AchievementDefinition::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_achievement_type()

void google_games_api::AchievementDefinition::set_achievement_type ( const StringPiece & value )

inline

Change the 'achievementType' attribute.

The type of the achievement. Possible values are:

"STANDARD": Achievement is either locked or unlocked.
"INCREMENTAL": Achievement is incremental.

Parameters

[in] value The new value.

◆ set_description()

void google_games_api::AchievementDefinition::set_description ( const StringPiece & value )

inline

Change the 'description' attribute.

The description of the achievement.

Parameters

[in] value The new value.

◆ set_experience_points()

void google_games_api::AchievementDefinition::set_experience_points ( int64 value )

inline

Change the 'experiencePoints' attribute.

Experience points which will be earned when unlocking this achievement.

Parameters

[in] value The new value.

◆ set_formatted_total_steps()

void google_games_api::AchievementDefinition::set_formatted_total_steps ( const StringPiece & value )

inline

Change the 'formattedTotalSteps' attribute.

The total steps for an incremental achievement as a string.

Parameters

[in] value The new value.

◆ set_id()

void google_games_api::AchievementDefinition::set_id ( const StringPiece & value )

inline

Change the 'id' attribute.

The ID of the achievement.

Parameters

[in] value The new value.

◆ set_initial_state()

void google_games_api::AchievementDefinition::set_initial_state ( const StringPiece & value )

inline

Change the 'initialState' attribute.

The initial state of the achievement. Possible values are:

"HIDDEN": Achievement is hidden.
"REVEALED": Achievement is revealed.
"UNLOCKED": Achievement is unlocked.

Parameters

[in] value The new value.

◆ set_is_revealed_icon_url_default()

void google_games_api::AchievementDefinition::set_is_revealed_icon_url_default ( bool value )

inline

Change the 'isRevealedIconUrlDefault' attribute.

Indicates whether the revealed icon image being returned is a default image, or is provided by the game.

Parameters

[in] value The new value.

◆ set_is_unlocked_icon_url_default()

void google_games_api::AchievementDefinition::set_is_unlocked_icon_url_default ( bool value )

inline

Change the 'isUnlockedIconUrlDefault' attribute.

Indicates whether the unlocked icon image being returned is a default image, or is game-provided.

Parameters

[in] value The new value.

◆ set_kind()

void google_games_api::AchievementDefinition::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

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

Parameters

[in] value The new value.

◆ set_name()

void google_games_api::AchievementDefinition::set_name ( const StringPiece & value )

inline

Change the 'name' attribute.

The name of the achievement.

Parameters

[in] value The new value.

◆ set_revealed_icon_url()

void google_games_api::AchievementDefinition::set_revealed_icon_url ( const StringPiece & value )

inline

Change the 'revealedIconUrl' attribute.

The image URL for the revealed achievement icon.

Parameters

[in] value The new value.

◆ set_total_steps()

void google_games_api::AchievementDefinition::set_total_steps ( int32 value )

inline

Change the 'totalSteps' attribute.

The total steps for an incremental achievement.

Parameters

[in] value The new value.

◆ set_unlocked_icon_url()

void google_games_api::AchievementDefinition::set_unlocked_icon_url ( const StringPiece & value )

inline

Change the 'unlockedIconUrl' attribute.

The image URL for the unlocked achievement icon.

Parameters

[in] value The new value.

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

google/games_api/achievement_definition.h
google/games_api/achievement_definition.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AchievementDefinition() [1/2]

◆ AchievementDefinition() [2/2]

◆ ~AchievementDefinition()

Member Function Documentation

◆ clear_achievement_type()

◆ clear_description()

◆ clear_experience_points()

◆ clear_formatted_total_steps()

◆ clear_id()

◆ clear_initial_state()

◆ clear_is_revealed_icon_url_default()

◆ clear_is_unlocked_icon_url_default()

◆ clear_kind()

◆ clear_name()

◆ clear_revealed_icon_url()

◆ clear_total_steps()

◆ clear_unlocked_icon_url()

◆ get_achievement_type()

◆ get_description()

◆ get_experience_points()

◆ get_formatted_total_steps()

◆ get_id()

◆ get_initial_state()

◆ get_is_revealed_icon_url_default()

◆ get_is_unlocked_icon_url_default()

◆ get_kind()

◆ get_name()

◆ get_revealed_icon_url()

◆ get_total_steps()

◆ get_unlocked_icon_url()

◆ GetTypeName()

◆ has_achievement_type()

◆ has_description()

◆ has_experience_points()

◆ has_formatted_total_steps()

◆ has_id()

◆ has_initial_state()

◆ has_is_revealed_icon_url_default()

◆ has_is_unlocked_icon_url_default()

◆ has_kind()

◆ has_name()

◆ has_revealed_icon_url()

◆ has_total_steps()

◆ has_unlocked_icon_url()

◆ New()

◆ set_achievement_type()

◆ set_description()

◆ set_experience_points()

◆ set_formatted_total_steps()

◆ set_id()

◆ set_initial_state()

◆ set_is_revealed_icon_url_default()

◆ set_is_unlocked_icon_url_default()

◆ set_kind()

◆ set_name()

◆ set_revealed_icon_url()

◆ set_total_steps()

◆ set_unlocked_icon_url()