google_games_api::Player::PlayerName Class Reference

#include <player.h>

Inheritance diagram for google_games_api::Player::PlayerName:

Public Member Functions
	PlayerName (const Json::Value &storage)
	PlayerName (Json::Value *storage)
virtual	~PlayerName ()
const StringPiece	GetTypeName () const
bool	has_family_name () const
void	clear_family_name ()
const StringPiece	get_family_name () const
void	set_family_name (const StringPiece &value)
bool	has_given_name () const
void	clear_given_name ()
const StringPiece	get_given_name () const
void	set_given_name (const StringPiece &value)

Static Public Member Functions
static PlayerName *	New ()

Detailed Description

An object representation of the individual components of the player's name. For some players, these fields may not be present.

Constructor & Destructor Documentation

PlayerName() [1/2]

google_games_api::Player::PlayerName::PlayerName ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

PlayerName() [2/2]

google_games_api::Player::PlayerName::PlayerName ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~PlayerName()

google_games_api::Player::PlayerName::~PlayerName ( )

virtual

Standard destructor.

Member Function Documentation

clear_family_name()

void google_games_api::Player::PlayerName::clear_family_name ( )

inline

Clears the 'familyName' attribute.

clear_given_name()

void google_games_api::Player::PlayerName::clear_given_name ( )

inline

Clears the 'givenName' attribute.

get_family_name()

const StringPiece google_games_api::Player::PlayerName::get_family_name ( ) const

inline

Get the value of the 'familyName' attribute.

get_given_name()

const StringPiece google_games_api::Player::PlayerName::get_given_name ( ) const

inline

Get the value of the 'givenName' attribute.

GetTypeName()

const StringPiece google_games_api::Player::PlayerName::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_games_api::PlayerName

has_family_name()

bool google_games_api::Player::PlayerName::has_family_name ( ) const

inline

Determine if the 'familyName' attribute was set.

Returns

true if the 'familyName' attribute was set.

has_given_name()

bool google_games_api::Player::PlayerName::has_given_name ( ) const

inline

Determine if the 'givenName' attribute was set.

Returns

true if the 'givenName' attribute was set.

New()

Player::PlayerName * google_games_api::Player::PlayerName::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_family_name()

void google_games_api::Player::PlayerName::set_family_name ( const StringPiece &  value )

inline

Change the 'familyName' attribute.

The family name of this player. In some places, this is known as the last name.

Parameters

[in]

value

The new value.

set_given_name()

void google_games_api::Player::PlayerName::set_given_name ( const StringPiece &  value )

inline

Change the 'givenName' attribute.

The given name of this player. In some places, this is known as the first name.

Parameters

[in]

value

The new value.

---

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

• google/games_api/player.h
• google/games_api/player.cc