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

#include <participant_result.h>

Inheritance diagram for google_games_api::ParticipantResult:

Public Member Functions

 ParticipantResult (const Json::Value &storage)
 
 ParticipantResult (Json::Value *storage)
 
virtual ~ParticipantResult ()
 
const StringPiece GetTypeName () const
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_participant_id () const
 
void clear_participant_id ()
 
const StringPiece get_participant_id () const
 
void set_participant_id (const StringPiece &value)
 
bool has_placing () const
 
void clear_placing ()
 
int32 get_placing () const
 
void set_placing (int32 value)
 
bool has_result () const
 
void clear_result ()
 
const StringPiece get_result () const
 
void set_result (const StringPiece &value)
 

Static Public Member Functions

static ParticipantResult * New ()
 

Detailed Description

This is a JSON template for a result for a match participant.

Constructor & Destructor Documentation

◆ ParticipantResult() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ ParticipantResult() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~ParticipantResult()

google_games_api::ParticipantResult::~ParticipantResult ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_kind()

void google_games_api::ParticipantResult::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_participant_id()

void google_games_api::ParticipantResult::clear_participant_id ( )
inline

Clears the 'participantId' attribute.

◆ clear_placing()

void google_games_api::ParticipantResult::clear_placing ( )
inline

Clears the 'placing' attribute.

◆ clear_result()

void google_games_api::ParticipantResult::clear_result ( )
inline

Clears the 'result' attribute.

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_participant_id()

const StringPiece google_games_api::ParticipantResult::get_participant_id ( ) const
inline

Get the value of the 'participantId' attribute.

◆ get_placing()

int32 google_games_api::ParticipantResult::get_placing ( ) const
inline

Get the value of the 'placing' attribute.

◆ get_result()

const StringPiece google_games_api::ParticipantResult::get_result ( ) const
inline

Get the value of the 'result' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_games_api::ParticipantResult

◆ has_kind()

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

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_participant_id()

bool google_games_api::ParticipantResult::has_participant_id ( ) const
inline

Determine if the 'participantId' attribute was set.

Returns
true if the 'participantId' attribute was set.

◆ has_placing()

bool google_games_api::ParticipantResult::has_placing ( ) const
inline

Determine if the 'placing' attribute was set.

Returns
true if the 'placing' attribute was set.

◆ has_result()

bool google_games_api::ParticipantResult::has_result ( ) const
inline

Determine if the 'result' attribute was set.

Returns
true if the 'result' attribute was set.

◆ New()

ParticipantResult * google_games_api::ParticipantResult::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_kind()

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

Change the 'kind' attribute.

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

Parameters
[in]valueThe new value.

◆ set_participant_id()

void google_games_api::ParticipantResult::set_participant_id ( const StringPiece &  value)
inline

Change the 'participantId' attribute.

The ID of the participant.

Parameters
[in]valueThe new value.

◆ set_placing()

void google_games_api::ParticipantResult::set_placing ( int32  value)
inline

Change the 'placing' attribute.

The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.

Parameters
[in]valueThe new value.

◆ set_result()

void google_games_api::ParticipantResult::set_result ( const StringPiece &  value)
inline

Change the 'result' attribute.

The result of the participant for this match. Possible values are:

"MATCH_RESULT_WIN"
The participant won the match.
"MATCH_RESULT_LOSS"
The participant lost the match.
"MATCH_RESULT_TIE"
The participant tied the match.
"MATCH_RESULT_NONE"
There was no winner for the match (nobody wins or loses this kind of game.).
"MATCH_RESULT_DISCONNECT"
The participant disconnected / left during the match.
"MATCH_RESULT_DISAGREED"
Different clients reported different results for this participant.
Parameters
[in]valueThe new value.
The documentation for this class was generated from the following files: