#include <player.h>
This is a JSON template for a Player resource.
◆ Player() [1/2]
google_games_api::Player::Player |
( |
const Json::Value & |
storage | ) |
|
|
explicit |
Standard constructor for an immutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ Player() [2/2]
google_games_api::Player::Player |
( |
Json::Value * |
storage | ) |
|
|
explicit |
Standard constructor for a mutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ ~Player()
google_games_api::Player::~Player |
( |
| ) |
|
|
virtual |
◆ clear_avatar_image_url()
void google_games_api::Player::clear_avatar_image_url |
( |
| ) |
|
|
inline |
Clears the 'avatarImageUrl
' attribute.
◆ clear_banner_url_landscape()
void google_games_api::Player::clear_banner_url_landscape |
( |
| ) |
|
|
inline |
Clears the 'bannerUrlLandscape
' attribute.
◆ clear_banner_url_portrait()
void google_games_api::Player::clear_banner_url_portrait |
( |
| ) |
|
|
inline |
Clears the 'bannerUrlPortrait
' attribute.
◆ clear_display_name()
void google_games_api::Player::clear_display_name |
( |
| ) |
|
|
inline |
Clears the 'displayName
' attribute.
◆ clear_experience_info()
void google_games_api::Player::clear_experience_info |
( |
| ) |
|
|
inline |
Clears the 'experienceInfo
' attribute.
◆ clear_kind()
void google_games_api::Player::clear_kind |
( |
| ) |
|
|
inline |
Clears the 'kind
' attribute.
◆ clear_last_played_with()
void google_games_api::Player::clear_last_played_with |
( |
| ) |
|
|
inline |
Clears the 'lastPlayedWith
' attribute.
◆ clear_name()
void google_games_api::Player::clear_name |
( |
| ) |
|
|
inline |
Clears the 'name
' attribute.
◆ clear_original_player_id()
void google_games_api::Player::clear_original_player_id |
( |
| ) |
|
|
inline |
Clears the 'originalPlayerId
' attribute.
◆ clear_player_id()
void google_games_api::Player::clear_player_id |
( |
| ) |
|
|
inline |
Clears the 'playerId
' attribute.
◆ clear_player_stattus()
void google_games_api::Player::clear_player_stattus |
( |
| ) |
|
|
inline |
Clears the 'playerStattus
' attribute.
◆ clear_profile_settings()
void google_games_api::Player::clear_profile_settings |
( |
| ) |
|
|
inline |
Clears the 'profileSettings
' attribute.
◆ clear_title()
void google_games_api::Player::clear_title |
( |
| ) |
|
|
inline |
Clears the 'title
' attribute.
◆ get_avatar_image_url()
const StringPiece google_games_api::Player::get_avatar_image_url |
( |
| ) |
const |
|
inline |
Get the value of the 'avatarImageUrl
' attribute.
◆ get_banner_url_landscape()
const StringPiece google_games_api::Player::get_banner_url_landscape |
( |
| ) |
const |
|
inline |
Get the value of the 'bannerUrlLandscape
' attribute.
◆ get_banner_url_portrait()
const StringPiece google_games_api::Player::get_banner_url_portrait |
( |
| ) |
const |
|
inline |
Get the value of the 'bannerUrlPortrait
' attribute.
◆ get_display_name()
const StringPiece google_games_api::Player::get_display_name |
( |
| ) |
const |
|
inline |
Get the value of the 'displayName
' attribute.
◆ get_experience_info()
Get a reference to the value of the 'experienceInfo
' attribute.
◆ get_kind()
const StringPiece google_games_api::Player::get_kind |
( |
| ) |
const |
|
inline |
Get the value of the 'kind
' attribute.
◆ get_last_played_with()
const Played google_games_api::Player::get_last_played_with |
( |
| ) |
const |
Get a reference to the value of the 'lastPlayedWith
' attribute.
◆ get_name()
const PlayerName google_games_api::Player::get_name |
( |
| ) |
const |
|
inline |
Get a reference to the value of the 'name
' attribute.
◆ get_original_player_id()
const StringPiece google_games_api::Player::get_original_player_id |
( |
| ) |
const |
|
inline |
Get the value of the 'originalPlayerId
' attribute.
◆ get_player_id()
const StringPiece google_games_api::Player::get_player_id |
( |
| ) |
const |
|
inline |
Get the value of the 'playerId
' attribute.
◆ get_player_stattus()
const StringPiece google_games_api::Player::get_player_stattus |
( |
| ) |
const |
|
inline |
Get the value of the 'playerStattus
' attribute.
◆ get_profile_settings()
const ProfileSettings google_games_api::Player::get_profile_settings |
( |
| ) |
const |
Get a reference to the value of the 'profileSettings
' attribute.
◆ get_title()
const StringPiece google_games_api::Player::get_title |
( |
| ) |
const |
|
inline |
Get the value of the 'title
' attribute.
◆ GetTypeName()
const StringPiece google_games_api::Player::GetTypeName |
( |
| ) |
const |
|
inline |
◆ has_avatar_image_url()
bool google_games_api::Player::has_avatar_image_url |
( |
| ) |
const |
|
inline |
Determine if the 'avatarImageUrl
' attribute was set.
- Returns
- true if the '
avatarImageUrl
' attribute was set.
◆ has_banner_url_landscape()
bool google_games_api::Player::has_banner_url_landscape |
( |
| ) |
const |
|
inline |
Determine if the 'bannerUrlLandscape
' attribute was set.
- Returns
- true if the '
bannerUrlLandscape
' attribute was set.
◆ has_banner_url_portrait()
bool google_games_api::Player::has_banner_url_portrait |
( |
| ) |
const |
|
inline |
Determine if the 'bannerUrlPortrait
' attribute was set.
- Returns
- true if the '
bannerUrlPortrait
' attribute was set.
◆ has_display_name()
bool google_games_api::Player::has_display_name |
( |
| ) |
const |
|
inline |
Determine if the 'displayName
' attribute was set.
- Returns
- true if the '
displayName
' attribute was set.
◆ has_experience_info()
bool google_games_api::Player::has_experience_info |
( |
| ) |
const |
|
inline |
Determine if the 'experienceInfo
' attribute was set.
- Returns
- true if the '
experienceInfo
' attribute was set.
◆ has_kind()
bool google_games_api::Player::has_kind |
( |
| ) |
const |
|
inline |
Determine if the 'kind
' attribute was set.
- Returns
- true if the '
kind
' attribute was set.
◆ has_last_played_with()
bool google_games_api::Player::has_last_played_with |
( |
| ) |
const |
|
inline |
Determine if the 'lastPlayedWith
' attribute was set.
- Returns
- true if the '
lastPlayedWith
' attribute was set.
◆ has_name()
bool google_games_api::Player::has_name |
( |
| ) |
const |
|
inline |
Determine if the 'name
' attribute was set.
- Returns
- true if the '
name
' attribute was set.
◆ has_original_player_id()
bool google_games_api::Player::has_original_player_id |
( |
| ) |
const |
|
inline |
Determine if the 'originalPlayerId
' attribute was set.
- Returns
- true if the '
originalPlayerId
' attribute was set.
◆ has_player_id()
bool google_games_api::Player::has_player_id |
( |
| ) |
const |
|
inline |
Determine if the 'playerId
' attribute was set.
- Returns
- true if the '
playerId
' attribute was set.
◆ has_player_stattus()
bool google_games_api::Player::has_player_stattus |
( |
| ) |
const |
|
inline |
Determine if the 'playerStattus
' attribute was set.
- Returns
- true if the '
playerStattus
' attribute was set.
◆ has_profile_settings()
bool google_games_api::Player::has_profile_settings |
( |
| ) |
const |
|
inline |
Determine if the 'profileSettings
' attribute was set.
- Returns
- true if the '
profileSettings
' attribute was set.
◆ has_title()
bool google_games_api::Player::has_title |
( |
| ) |
const |
|
inline |
Determine if the 'title
' attribute was set.
- Returns
- true if the '
title
' attribute was set.
◆ mutable_experienceInfo()
Gets a reference to a mutable value of the 'experienceInfo
' property.
An object to represent Play Game experience information for the player.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_lastPlayedWith()
Played google_games_api::Player::mutable_lastPlayedWith |
( |
| ) |
|
Gets a reference to a mutable value of the 'lastPlayedWith
' property.
Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_name()
PlayerName google_games_api::Player::mutable_name |
( |
| ) |
|
|
inline |
Gets a reference to a mutable value of the 'name
' property.
An object representation of the individual components of the player's name. For some players, these fields may not be present.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_profileSettings()
Gets a reference to a mutable value of the 'profileSettings
' property.
The player's profile settings. Controls whether or not the player's profile is visible to other players.
- Returns
- The result can be modified to change the attribute value.
◆ New()
Player * google_games_api::Player::New |
( |
| ) |
|
|
static |
Creates a new default instance.
- Returns
- Ownership is passed back to the caller.
◆ set_avatar_image_url()
void google_games_api::Player::set_avatar_image_url |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'avatarImageUrl
' attribute.
The base URL for the image that represents the player.
- Parameters
-
◆ set_banner_url_landscape()
void google_games_api::Player::set_banner_url_landscape |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'bannerUrlLandscape
' attribute.
The url to the landscape mode player banner image.
- Parameters
-
◆ set_banner_url_portrait()
void google_games_api::Player::set_banner_url_portrait |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'bannerUrlPortrait
' attribute.
The url to the portrait mode player banner image.
- Parameters
-
◆ set_display_name()
void google_games_api::Player::set_display_name |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'displayName
' attribute.
The name to display for the player.
- Parameters
-
◆ set_kind()
void google_games_api::Player::set_kind |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'kind
' attribute.
Uniquely identifies the type of this resource. Value is always the fixed string games::player.
- Parameters
-
◆ set_original_player_id()
void google_games_api::Player::set_original_player_id |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'originalPlayerId
' attribute.
The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
- Parameters
-
◆ set_player_id()
void google_games_api::Player::set_player_id |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'playerId
' attribute.
The ID of the player.
- Parameters
-
◆ set_player_stattus()
void google_games_api::Player::set_player_stattus |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'playerStattus
' attribute.
- Parameters
-
◆ set_title()
void google_games_api::Player::set_title |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'title
' attribute.
The player's title rewarded for their game activities.
- Parameters
-
The documentation for this class was generated from the following files:
- google/games_api/player.h
- google/games_api/player.cc