#include <turn_based_match.h>

Inheritance diagram for google_games_api::TurnBasedMatch:

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

	TurnBasedMatch (Json::Value *storage)

virtual	~TurnBasedMatch ()

const StringPiece	GetTypeName () const

bool	has_application_id () const

void	clear_application_id ()

const StringPiece	get_application_id () const

void	set_application_id (const StringPiece &value)

bool	has_auto_matching_criteria () const

void	clear_auto_matching_criteria ()

const TurnBasedAutoMatchingCriteria	get_auto_matching_criteria () const

TurnBasedAutoMatchingCriteria	mutable_autoMatchingCriteria ()

bool	has_creation_details () const

void	clear_creation_details ()

const TurnBasedMatchModification	get_creation_details () const

TurnBasedMatchModification	mutable_creationDetails ()

bool	has_data () const

void	clear_data ()

const TurnBasedMatchData	get_data () const

TurnBasedMatchData	mutable_data ()

bool	has_description () const

void	clear_description ()

const StringPiece	get_description () const

void	set_description (const StringPiece &value)

bool	has_inviter_id () const

void	clear_inviter_id ()

const StringPiece	get_inviter_id () const

void	set_inviter_id (const StringPiece &value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_last_update_details () const

void	clear_last_update_details ()

const TurnBasedMatchModification	get_last_update_details () const

TurnBasedMatchModification	mutable_lastUpdateDetails ()

bool	has_match_id () const

void	clear_match_id ()

const StringPiece	get_match_id () const

void	set_match_id (const StringPiece &value)

bool	has_match_number () const

void	clear_match_number ()

int32	get_match_number () const

void	set_match_number (int32 value)

bool	has_match_version () const

void	clear_match_version ()

int32	get_match_version () const

void	set_match_version (int32 value)

bool	has_participants () const

void	clear_participants ()

const client::JsonCppArray< TurnBasedMatchParticipant >	get_participants () const

client::JsonCppArray< TurnBasedMatchParticipant >	mutable_participants ()

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

void	clear_previous_match_data ()

const TurnBasedMatchData	get_previous_match_data () const

TurnBasedMatchData	mutable_previousMatchData ()

bool	has_rematch_id () const

void	clear_rematch_id ()

const StringPiece	get_rematch_id () const

void	set_rematch_id (const StringPiece &value)

bool	has_results () const

void	clear_results ()

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

client::JsonCppArray< ParticipantResult >	mutable_results ()

bool	has_status () const

void	clear_status ()

const StringPiece	get_status () const

void	set_status (const StringPiece &value)

bool	has_user_match_status () const

void	clear_user_match_status ()

const StringPiece	get_user_match_status () const

void	set_user_match_status (const StringPiece &value)

bool	has_variant () const

void	clear_variant ()

int32	get_variant () const

void	set_variant (int32 value)

bool	has_with_participant_id () const

void	clear_with_participant_id ()

const StringPiece	get_with_participant_id () const

void	set_with_participant_id (const StringPiece &value)

Static Public Member Functions
static TurnBasedMatch *	New ()

Detailed Description

This is a JSON template for a turn-based match resource object.

Constructor & Destructor Documentation

◆ TurnBasedMatch() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ TurnBasedMatch() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~TurnBasedMatch()

google_games_api::TurnBasedMatch::~TurnBasedMatch ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_application_id()

void google_games_api::TurnBasedMatch::clear_application_id ( )

inline

Clears the 'applicationId' attribute.

◆ clear_auto_matching_criteria()

void google_games_api::TurnBasedMatch::clear_auto_matching_criteria ( )

inline

Clears the 'autoMatchingCriteria' attribute.

◆ clear_creation_details()

void google_games_api::TurnBasedMatch::clear_creation_details ( )

inline

Clears the 'creationDetails' attribute.

◆ clear_data()

void google_games_api::TurnBasedMatch::clear_data ( )

inline

Clears the 'data' attribute.

◆ clear_description()

void google_games_api::TurnBasedMatch::clear_description ( )

inline

Clears the 'description' attribute.

◆ clear_inviter_id()

void google_games_api::TurnBasedMatch::clear_inviter_id ( )

inline

Clears the 'inviterId' attribute.

◆ clear_kind()

void google_games_api::TurnBasedMatch::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_last_update_details()

void google_games_api::TurnBasedMatch::clear_last_update_details ( )

inline

Clears the 'lastUpdateDetails' attribute.

◆ clear_match_id()

void google_games_api::TurnBasedMatch::clear_match_id ( )

inline

Clears the 'matchId' attribute.

◆ clear_match_number()

void google_games_api::TurnBasedMatch::clear_match_number ( )

inline

Clears the 'matchNumber' attribute.

◆ clear_match_version()

void google_games_api::TurnBasedMatch::clear_match_version ( )

inline

Clears the 'matchVersion' attribute.

◆ clear_participants()

void google_games_api::TurnBasedMatch::clear_participants ( )

inline

Clears the 'participants' attribute.

◆ clear_pending_participant_id()

void google_games_api::TurnBasedMatch::clear_pending_participant_id ( )

inline

Clears the 'pendingParticipantId' attribute.

◆ clear_previous_match_data()

void google_games_api::TurnBasedMatch::clear_previous_match_data ( )

inline

Clears the 'previousMatchData' attribute.

◆ clear_rematch_id()

void google_games_api::TurnBasedMatch::clear_rematch_id ( )

inline

Clears the 'rematchId' attribute.

◆ clear_results()

void google_games_api::TurnBasedMatch::clear_results ( )

inline

Clears the 'results' attribute.

◆ clear_status()

void google_games_api::TurnBasedMatch::clear_status ( )

inline

Clears the 'status' attribute.

◆ clear_user_match_status()

void google_games_api::TurnBasedMatch::clear_user_match_status ( )

inline

Clears the 'userMatchStatus' attribute.

◆ clear_variant()

void google_games_api::TurnBasedMatch::clear_variant ( )

inline

Clears the 'variant' attribute.

◆ clear_with_participant_id()

void google_games_api::TurnBasedMatch::clear_with_participant_id ( )

inline

Clears the 'withParticipantId' attribute.

◆ get_application_id()

const StringPiece google_games_api::TurnBasedMatch::get_application_id ( ) const

inline

Get the value of the 'applicationId' attribute.

◆ get_auto_matching_criteria()

const TurnBasedAutoMatchingCriteria google_games_api::TurnBasedMatch::get_auto_matching_criteria ( ) const

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

◆ get_creation_details()

const TurnBasedMatchModification google_games_api::TurnBasedMatch::get_creation_details ( ) const

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

◆ get_data()

const TurnBasedMatchData google_games_api::TurnBasedMatch::get_data ( ) const

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

◆ get_description()

const StringPiece google_games_api::TurnBasedMatch::get_description ( ) const

inline

Get the value of the 'description' attribute.

◆ get_inviter_id()

const StringPiece google_games_api::TurnBasedMatch::get_inviter_id ( ) const

inline

Get the value of the 'inviterId' attribute.

◆ get_kind()

const StringPiece google_games_api::TurnBasedMatch::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_last_update_details()

const TurnBasedMatchModification google_games_api::TurnBasedMatch::get_last_update_details ( ) const

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

◆ get_match_id()

const StringPiece google_games_api::TurnBasedMatch::get_match_id ( ) const

inline

Get the value of the 'matchId' attribute.

◆ get_match_number()

int32 google_games_api::TurnBasedMatch::get_match_number ( ) const

inline

Get the value of the 'matchNumber' attribute.

◆ get_match_version()

int32 google_games_api::TurnBasedMatch::get_match_version ( ) const

inline

Get the value of the 'matchVersion' attribute.

◆ get_participants()

const client::JsonCppArray<TurnBasedMatchParticipant > google_games_api::TurnBasedMatch::get_participants ( ) const

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

◆ get_pending_participant_id()

const StringPiece google_games_api::TurnBasedMatch::get_pending_participant_id ( ) const

inline

Get the value of the 'pendingParticipantId' attribute.

◆ get_previous_match_data()

const TurnBasedMatchData google_games_api::TurnBasedMatch::get_previous_match_data ( ) const

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

◆ get_rematch_id()

const StringPiece google_games_api::TurnBasedMatch::get_rematch_id ( ) const

inline

Get the value of the 'rematchId' attribute.

◆ get_results()

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

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

◆ get_status()

const StringPiece google_games_api::TurnBasedMatch::get_status ( ) const

inline

Get the value of the 'status' attribute.

◆ get_user_match_status()

const StringPiece google_games_api::TurnBasedMatch::get_user_match_status ( ) const

inline

Get the value of the 'userMatchStatus' attribute.

◆ get_variant()

int32 google_games_api::TurnBasedMatch::get_variant ( ) const

inline

Get the value of the 'variant' attribute.

◆ get_with_participant_id()

const StringPiece google_games_api::TurnBasedMatch::get_with_participant_id ( ) const

inline

Get the value of the 'withParticipantId' attribute.

◆ GetTypeName()

const StringPiece google_games_api::TurnBasedMatch::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_games_api::TurnBasedMatch

◆ has_application_id()

bool google_games_api::TurnBasedMatch::has_application_id ( ) const

inline

Determine if the 'applicationId' attribute was set.

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

◆ has_auto_matching_criteria()

bool google_games_api::TurnBasedMatch::has_auto_matching_criteria ( ) const

inline

Determine if the 'autoMatchingCriteria' attribute was set.

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

◆ has_creation_details()

bool google_games_api::TurnBasedMatch::has_creation_details ( ) const

inline

Determine if the 'creationDetails' attribute was set.

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

◆ has_data()

bool google_games_api::TurnBasedMatch::has_data ( ) const

inline

Determine if the 'data' attribute was set.

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

◆ has_description()

bool google_games_api::TurnBasedMatch::has_description ( ) const

inline

Determine if the 'description' attribute was set.

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

◆ has_inviter_id()

bool google_games_api::TurnBasedMatch::has_inviter_id ( ) const

inline

Determine if the 'inviterId' attribute was set.

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

◆ has_kind()

bool google_games_api::TurnBasedMatch::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

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

◆ has_last_update_details()

bool google_games_api::TurnBasedMatch::has_last_update_details ( ) const

inline

Determine if the 'lastUpdateDetails' attribute was set.

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

◆ has_match_id()

bool google_games_api::TurnBasedMatch::has_match_id ( ) const

inline

Determine if the 'matchId' attribute was set.

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

◆ has_match_number()

bool google_games_api::TurnBasedMatch::has_match_number ( ) const

inline

Determine if the 'matchNumber' attribute was set.

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

◆ has_match_version()

bool google_games_api::TurnBasedMatch::has_match_version ( ) const

inline

Determine if the 'matchVersion' attribute was set.

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

◆ has_participants()

bool google_games_api::TurnBasedMatch::has_participants ( ) const

inline

Determine if the 'participants' attribute was set.

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

◆ has_pending_participant_id()

bool google_games_api::TurnBasedMatch::has_pending_participant_id ( ) const

inline

Determine if the 'pendingParticipantId' attribute was set.

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

◆ has_previous_match_data()

bool google_games_api::TurnBasedMatch::has_previous_match_data ( ) const

inline

Determine if the 'previousMatchData' attribute was set.

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

◆ has_rematch_id()

bool google_games_api::TurnBasedMatch::has_rematch_id ( ) const

inline

Determine if the 'rematchId' attribute was set.

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

◆ has_results()

bool google_games_api::TurnBasedMatch::has_results ( ) const

inline

Determine if the 'results' attribute was set.

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

◆ has_status()

bool google_games_api::TurnBasedMatch::has_status ( ) const

inline

Determine if the 'status' attribute was set.

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

◆ has_user_match_status()

bool google_games_api::TurnBasedMatch::has_user_match_status ( ) const

inline

Determine if the 'userMatchStatus' attribute was set.

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

◆ has_variant()

bool google_games_api::TurnBasedMatch::has_variant ( ) const

inline

Determine if the 'variant' attribute was set.

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

◆ has_with_participant_id()

bool google_games_api::TurnBasedMatch::has_with_participant_id ( ) const

inline

Determine if the 'withParticipantId' attribute was set.

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

◆ mutable_autoMatchingCriteria()

TurnBasedAutoMatchingCriteria google_games_api::TurnBasedMatch::mutable_autoMatchingCriteria ( )

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

Criteria for auto-matching players into this match.

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

◆ mutable_creationDetails()

TurnBasedMatchModification google_games_api::TurnBasedMatch::mutable_creationDetails ( )

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

Details about the match creation.

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

◆ mutable_data()

TurnBasedMatchData google_games_api::TurnBasedMatch::mutable_data ( )

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

The data / game state for this match.

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

◆ mutable_lastUpdateDetails()

TurnBasedMatchModification google_games_api::TurnBasedMatch::mutable_lastUpdateDetails ( )

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

Details about the last update to the match.

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

◆ mutable_participants()

client::JsonCppArray<TurnBasedMatchParticipant > google_games_api::TurnBasedMatch::mutable_participants ( )

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

The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.

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

◆ mutable_previousMatchData()

TurnBasedMatchData google_games_api::TurnBasedMatch::mutable_previousMatchData ( )

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

The data / game state for the previous match; set for the first turn of rematches only.

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

◆ mutable_results()

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

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

The results reported for this match.

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

◆ New()

TurnBasedMatch * google_games_api::TurnBasedMatch::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_application_id()

void google_games_api::TurnBasedMatch::set_application_id ( const StringPiece & value )

inline

Change the 'applicationId' attribute.

The ID of the application being played.

Parameters

[in] value The new value.

◆ set_description()

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

inline

Change the 'description' attribute.

This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.

Parameters

[in] value The new value.

◆ set_inviter_id()

void google_games_api::TurnBasedMatch::set_inviter_id ( const StringPiece & value )

inline

Change the 'inviterId' attribute.

The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.

Parameters

[in] value The new value.

◆ set_kind()

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

inline

Change the 'kind' attribute.

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

Parameters

[in] value The new value.

◆ set_match_id()

void google_games_api::TurnBasedMatch::set_match_id ( const StringPiece & value )

inline

Change the 'matchId' attribute.

Globally unique ID for a turn-based match.

Parameters

[in] value The new value.

◆ set_match_number()

void google_games_api::TurnBasedMatch::set_match_number ( int32 value )

inline

Change the 'matchNumber' attribute.

The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.

Parameters

[in] value The new value.

◆ set_match_version()

void google_games_api::TurnBasedMatch::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] value The new value.

◆ set_pending_participant_id()

void google_games_api::TurnBasedMatch::set_pending_participant_id ( const StringPiece & value )

inline

Change the 'pendingParticipantId' attribute.

The ID of the participant that is taking a turn.

Parameters

[in] value The new value.

◆ set_rematch_id()

void google_games_api::TurnBasedMatch::set_rematch_id ( const StringPiece & value )

inline

Change the 'rematchId' attribute.

The ID of a rematch of this match. Only set for completed matches that have been rematched.

Parameters

[in] value The new value.

◆ set_status()

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

inline

Change the 'status' attribute.

The status of the match. Possible values are:

"MATCH_AUTO_MATCHING": One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
"MATCH_ACTIVE": The match has started.
"MATCH_COMPLETE": The match has finished.
"MATCH_CANCELED": The match was canceled.
"MATCH_EXPIRED": The match expired due to inactivity.
"MATCH_DELETED": The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.

Parameters

[in] value The new value.

◆ set_user_match_status()

void google_games_api::TurnBasedMatch::set_user_match_status ( const StringPiece & value )

inline

Change the 'userMatchStatus' attribute.

The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match. Possible values are:

"USER_INVITED": The user has been invited to join the match and has not responded yet.
"USER_AWAITING_TURN": The user is waiting for their turn.
"USER_TURN": The user has an action to take in the match.
"USER_MATCH_COMPLETED": The match has ended (it is completed, canceled, or expired.).

Parameters

[in] value The new value.

◆ set_variant()

void google_games_api::TurnBasedMatch::set_variant ( int32 value )

inline

Change the 'variant' attribute.

The variant / mode of the application being played; can be any integer value, or left blank.

Parameters

[in] value The new value.

◆ set_with_participant_id()

void google_games_api::TurnBasedMatch::set_with_participant_id ( const StringPiece & value )

inline

Change the 'withParticipantId' attribute.

The ID of another participant in the match that can be used when describing the participants the user is playing with.

Parameters

[in] value The new value.

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

google/games_api/turn_based_match.h
google/games_api/turn_based_match.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TurnBasedMatch() [1/2]

◆ TurnBasedMatch() [2/2]

◆ ~TurnBasedMatch()

Member Function Documentation

◆ clear_application_id()

◆ clear_auto_matching_criteria()

◆ clear_creation_details()

◆ clear_data()

◆ clear_description()

◆ clear_inviter_id()

◆ clear_kind()

◆ clear_last_update_details()

◆ clear_match_id()

◆ clear_match_number()

◆ clear_match_version()

◆ clear_participants()

◆ clear_pending_participant_id()

◆ clear_previous_match_data()

◆ clear_rematch_id()

◆ clear_results()

◆ clear_status()

◆ clear_user_match_status()

◆ clear_variant()

◆ clear_with_participant_id()

◆ get_application_id()

◆ get_auto_matching_criteria()

◆ get_creation_details()

◆ get_data()

◆ get_description()

◆ get_inviter_id()

◆ get_kind()

◆ get_last_update_details()

◆ get_match_id()

◆ get_match_number()

◆ get_match_version()

◆ get_participants()

◆ get_pending_participant_id()

◆ get_previous_match_data()

◆ get_rematch_id()

◆ get_results()

◆ get_status()

◆ get_user_match_status()

◆ get_variant()

◆ get_with_participant_id()

◆ GetTypeName()

◆ has_application_id()

◆ has_auto_matching_criteria()

◆ has_creation_details()

◆ has_data()

◆ has_description()

◆ has_inviter_id()

◆ has_kind()

◆ has_last_update_details()

◆ has_match_id()

◆ has_match_number()

◆ has_match_version()

◆ has_participants()

◆ has_pending_participant_id()

◆ has_previous_match_data()

◆ has_rematch_id()

◆ has_results()

◆ has_status()

◆ has_user_match_status()

◆ has_variant()

◆ has_with_participant_id()

◆ mutable_autoMatchingCriteria()

◆ mutable_creationDetails()

◆ mutable_data()

◆ mutable_lastUpdateDetails()

◆ mutable_participants()

◆ mutable_previousMatchData()

◆ mutable_results()

◆ New()

◆ set_application_id()

◆ set_description()

◆ set_inviter_id()