#include <turn_based_match_participant.h>

Inheritance diagram for google_games_api::TurnBasedMatchParticipant:

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

	TurnBasedMatchParticipant (Json::Value *storage)

virtual	~TurnBasedMatchParticipant ()

const StringPiece	GetTypeName () const

bool	has_auto_matched () const

void	clear_auto_matched ()

bool	get_auto_matched () const

void	set_auto_matched (bool value)

bool	has_auto_matched_player () const

void	clear_auto_matched_player ()

const AnonymousPlayer	get_auto_matched_player () const

AnonymousPlayer	mutable_autoMatchedPlayer ()

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_player () const

void	clear_player ()

const Player	get_player () const

Player	mutable_player ()

bool	has_status () const

void	clear_status ()

const StringPiece	get_status () const

void	set_status (const StringPiece &value)

Static Public Member Functions
static TurnBasedMatchParticipant *	New ()

Detailed Description

This is a JSON template for a participant in a turn-based match.

Constructor & Destructor Documentation

◆ TurnBasedMatchParticipant() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ TurnBasedMatchParticipant() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~TurnBasedMatchParticipant()

google_games_api::TurnBasedMatchParticipant::~TurnBasedMatchParticipant ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_auto_matched()

void google_games_api::TurnBasedMatchParticipant::clear_auto_matched ( )

inline

Clears the 'autoMatched' attribute.

◆ clear_auto_matched_player()

void google_games_api::TurnBasedMatchParticipant::clear_auto_matched_player ( )

inline

Clears the 'autoMatchedPlayer' attribute.

◆ clear_id()

void google_games_api::TurnBasedMatchParticipant::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_kind()

void google_games_api::TurnBasedMatchParticipant::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_player()

void google_games_api::TurnBasedMatchParticipant::clear_player ( )

inline

Clears the 'player' attribute.

◆ clear_status()

void google_games_api::TurnBasedMatchParticipant::clear_status ( )

inline

Clears the 'status' attribute.

◆ get_auto_matched()

bool google_games_api::TurnBasedMatchParticipant::get_auto_matched ( ) const

inline

Get the value of the 'autoMatched' attribute.

◆ get_auto_matched_player()

const AnonymousPlayer google_games_api::TurnBasedMatchParticipant::get_auto_matched_player ( ) const

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

◆ get_id()

const StringPiece google_games_api::TurnBasedMatchParticipant::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_games_api::TurnBasedMatchParticipant::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_player()

const Player google_games_api::TurnBasedMatchParticipant::get_player ( ) const

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

◆ get_status()

const StringPiece google_games_api::TurnBasedMatchParticipant::get_status ( ) const

inline

Get the value of the 'status' attribute.

◆ GetTypeName()

const StringPiece google_games_api::TurnBasedMatchParticipant::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_games_api::TurnBasedMatchParticipant

◆ has_auto_matched()

bool google_games_api::TurnBasedMatchParticipant::has_auto_matched ( ) const

inline

Determine if the 'autoMatched' attribute was set.

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

◆ has_auto_matched_player()

bool google_games_api::TurnBasedMatchParticipant::has_auto_matched_player ( ) const

inline

Determine if the 'autoMatchedPlayer' attribute was set.

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

◆ has_id()

bool google_games_api::TurnBasedMatchParticipant::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::TurnBasedMatchParticipant::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

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

◆ has_player()

bool google_games_api::TurnBasedMatchParticipant::has_player ( ) const

inline

Determine if the 'player' attribute was set.

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

◆ has_status()

bool google_games_api::TurnBasedMatchParticipant::has_status ( ) const

inline

Determine if the 'status' attribute was set.

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

◆ mutable_autoMatchedPlayer()

AnonymousPlayer google_games_api::TurnBasedMatchParticipant::mutable_autoMatchedPlayer ( )

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

Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.).

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

◆ mutable_player()

Player google_games_api::TurnBasedMatchParticipant::mutable_player ( )

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

Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.).

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

◆ New()

TurnBasedMatchParticipant * google_games_api::TurnBasedMatchParticipant::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_auto_matched()

void google_games_api::TurnBasedMatchParticipant::set_auto_matched ( bool value )

inline

Change the 'autoMatched' attribute.

True if this participant was auto-matched with the requesting player.

Parameters

[in] value The new value.

◆ set_id()

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

inline

Change the 'id' attribute.

An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.

Parameters

[in] value The new value.

◆ set_kind()

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

inline

Change the 'kind' attribute.

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

Parameters

[in] value The new value.

◆ set_status()

void google_games_api::TurnBasedMatchParticipant::set_status ( const StringPiece & value )

inline

Change the 'status' attribute.

The status of the participant with respect to the match. Possible values are:

"PARTICIPANT_NOT_INVITED_YET": The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
"PARTICIPANT_INVITED": The participant has been invited to join the match, but has not yet responded.
"PARTICIPANT_JOINED": The participant has joined the match (either after creating it or accepting an invitation.).
"PARTICIPANT_DECLINED": The participant declined an invitation to join the match.
"PARTICIPANT_LEFT": The participant joined the match and then left it.
"PARTICIPANT_FINISHED": The participant finished playing in the match.
"PARTICIPANT_UNRESPONSIVE": The participant did not take their turn in the allotted time.

Parameters

[in] value The new value.

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

google/games_api/turn_based_match_participant.h
google/games_api/turn_based_match_participant.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TurnBasedMatchParticipant() [1/2]

◆ TurnBasedMatchParticipant() [2/2]

◆ ~TurnBasedMatchParticipant()

Member Function Documentation

◆ clear_auto_matched()

◆ clear_auto_matched_player()

◆ clear_id()

◆ clear_kind()

◆ clear_player()

◆ clear_status()

◆ get_auto_matched()

◆ get_auto_matched_player()

◆ get_id()

◆ get_kind()

◆ get_player()

◆ get_status()

◆ GetTypeName()

◆ has_auto_matched()

◆ has_auto_matched_player()

◆ has_id()

◆ has_kind()

◆ has_player()

◆ has_status()

◆ mutable_autoMatchedPlayer()

◆ mutable_player()

◆ New()

◆ set_auto_matched()

◆ set_id()

◆ set_kind()

◆ set_status()