games  v1
Public Member Functions | Static Public Member Functions | List of all members
google_games_api::TurnBasedMatchTurn Class Reference
Google Play Game Services API Data Objects

#include <turn_based_match_turn.h>

Inheritance diagram for google_games_api::TurnBasedMatchTurn:

Public Member Functions

 TurnBasedMatchTurn (const Json::Value &storage)
 
 TurnBasedMatchTurn (Json::Value *storage)
 
virtual ~TurnBasedMatchTurn ()
 
const StringPiece GetTypeName () const
 
bool has_data () const
 
void clear_data ()
 
const TurnBasedMatchDataRequest get_data () const
 
TurnBasedMatchDataRequest mutable_data ()
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_match_version () const
 
void clear_match_version ()
 
int32 get_match_version () const
 
void set_match_version (int32 value)
 
bool has_pending_participant_id () const
 
void clear_pending_participant_id ()
 
const StringPiece get_pending_participant_id () const
 
void set_pending_participant_id (const StringPiece &value)
 
bool has_results () const
 
void clear_results ()
 
const client::JsonCppArray< ParticipantResult > get_results () const
 
client::JsonCppArray< ParticipantResult > mutable_results ()
 

Static Public Member Functions

static TurnBasedMatchTurn * New ()
 

Detailed Description

This is a JSON template for the object representing a turn.

Constructor & Destructor Documentation

◆ TurnBasedMatchTurn() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ TurnBasedMatchTurn() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~TurnBasedMatchTurn()

google_games_api::TurnBasedMatchTurn::~TurnBasedMatchTurn ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_data()

void google_games_api::TurnBasedMatchTurn::clear_data ( )
inline

Clears the 'data' attribute.

◆ clear_kind()

void google_games_api::TurnBasedMatchTurn::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_match_version()

void google_games_api::TurnBasedMatchTurn::clear_match_version ( )
inline

Clears the 'matchVersion' attribute.

◆ clear_pending_participant_id()

void google_games_api::TurnBasedMatchTurn::clear_pending_participant_id ( )
inline

Clears the 'pendingParticipantId' attribute.

◆ clear_results()

void google_games_api::TurnBasedMatchTurn::clear_results ( )
inline

Clears the 'results' attribute.

◆ get_data()

const TurnBasedMatchDataRequest google_games_api::TurnBasedMatchTurn::get_data ( ) const

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

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_match_version()

int32 google_games_api::TurnBasedMatchTurn::get_match_version ( ) const
inline

Get the value of the 'matchVersion' attribute.

◆ get_pending_participant_id()

const StringPiece google_games_api::TurnBasedMatchTurn::get_pending_participant_id ( ) const
inline

Get the value of the 'pendingParticipantId' attribute.

◆ get_results()

const client::JsonCppArray<ParticipantResult > google_games_api::TurnBasedMatchTurn::get_results ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_games_api::TurnBasedMatchTurn

◆ has_data()

bool google_games_api::TurnBasedMatchTurn::has_data ( ) const
inline

Determine if the 'data' attribute was set.

Returns
true if the 'data' attribute was set.

◆ has_kind()

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

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_match_version()

bool google_games_api::TurnBasedMatchTurn::has_match_version ( ) const
inline

Determine if the 'matchVersion' attribute was set.

Returns
true if the 'matchVersion' attribute was set.

◆ has_pending_participant_id()

bool google_games_api::TurnBasedMatchTurn::has_pending_participant_id ( ) const
inline

Determine if the 'pendingParticipantId' attribute was set.

Returns
true if the 'pendingParticipantId' attribute was set.

◆ has_results()

bool google_games_api::TurnBasedMatchTurn::has_results ( ) const
inline

Determine if the 'results' attribute was set.

Returns
true if the 'results' attribute was set.

◆ mutable_data()

TurnBasedMatchDataRequest google_games_api::TurnBasedMatchTurn::mutable_data ( )

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

The shared game state data after the turn is over.

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

◆ mutable_results()

client::JsonCppArray<ParticipantResult > google_games_api::TurnBasedMatchTurn::mutable_results ( )

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

The match results for the participants in the match.

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

◆ New()

TurnBasedMatchTurn * google_games_api::TurnBasedMatchTurn::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_kind()

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

Change the 'kind' attribute.

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

Parameters
[in]valueThe new value.

◆ set_match_version()

void google_games_api::TurnBasedMatchTurn::set_match_version ( int32  value)
inline

Change the 'matchVersion' attribute.

The version of this match: an increasing counter, used to avoid out-of-date updates to the match.

Parameters
[in]valueThe new value.

◆ set_pending_participant_id()

void google_games_api::TurnBasedMatchTurn::set_pending_participant_id ( const StringPiece &  value)
inline

Change the 'pendingParticipantId' attribute.

The ID of the participant who should take their turn next. May be set to the current player's participant ID to update match state without changing the turn. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players.

Parameters
[in]valueThe new value.
The documentation for this class was generated from the following files: