#include <room_participant.h>

Inheritance diagram for google_games_api::RoomParticipant:

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

	RoomParticipant (Json::Value *storage)

virtual	~RoomParticipant ()

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

void	clear_capabilities ()

const client::JsonCppArray< string >	get_capabilities () const

client::JsonCppArray< string >	mutable_capabilities ()

bool	has_client_address () const

void	clear_client_address ()

const RoomClientAddress	get_client_address () const

RoomClientAddress	mutable_clientAddress ()

bool	has_connected () const

void	clear_connected ()

bool	get_connected () const

void	set_connected (bool value)

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

void	clear_leave_reason ()

const StringPiece	get_leave_reason () const

void	set_leave_reason (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 RoomParticipant *	New ()

Detailed Description

This is a JSON template for a participant in a room.

Constructor & Destructor Documentation

◆ RoomParticipant() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ RoomParticipant() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~RoomParticipant()

google_games_api::RoomParticipant::~RoomParticipant ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_auto_matched()

void google_games_api::RoomParticipant::clear_auto_matched ( )

inline

Clears the 'autoMatched' attribute.

◆ clear_auto_matched_player()

void google_games_api::RoomParticipant::clear_auto_matched_player ( )

inline

Clears the 'autoMatchedPlayer' attribute.

◆ clear_capabilities()

void google_games_api::RoomParticipant::clear_capabilities ( )

inline

Clears the 'capabilities' attribute.

◆ clear_client_address()

void google_games_api::RoomParticipant::clear_client_address ( )

inline

Clears the 'clientAddress' attribute.

◆ clear_connected()

void google_games_api::RoomParticipant::clear_connected ( )

inline

Clears the 'connected' attribute.

◆ clear_id()

void google_games_api::RoomParticipant::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_kind()

void google_games_api::RoomParticipant::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_leave_reason()

void google_games_api::RoomParticipant::clear_leave_reason ( )

inline

Clears the 'leaveReason' attribute.

◆ clear_player()

void google_games_api::RoomParticipant::clear_player ( )

inline

Clears the 'player' attribute.

◆ clear_status()

void google_games_api::RoomParticipant::clear_status ( )

inline

Clears the 'status' attribute.

◆ get_auto_matched()

bool google_games_api::RoomParticipant::get_auto_matched ( ) const

inline

Get the value of the 'autoMatched' attribute.

◆ get_auto_matched_player()

const AnonymousPlayer google_games_api::RoomParticipant::get_auto_matched_player ( ) const

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

◆ get_capabilities()

const client::JsonCppArray<string > google_games_api::RoomParticipant::get_capabilities ( ) const

inline

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

◆ get_client_address()

const RoomClientAddress google_games_api::RoomParticipant::get_client_address ( ) const

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

◆ get_connected()

bool google_games_api::RoomParticipant::get_connected ( ) const

inline

Get the value of the 'connected' attribute.

◆ get_id()

const StringPiece google_games_api::RoomParticipant::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_games_api::RoomParticipant::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_leave_reason()

const StringPiece google_games_api::RoomParticipant::get_leave_reason ( ) const

inline

Get the value of the 'leaveReason' attribute.

◆ get_player()

const Player google_games_api::RoomParticipant::get_player ( ) const

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

◆ get_status()

const StringPiece google_games_api::RoomParticipant::get_status ( ) const

inline

Get the value of the 'status' attribute.

◆ GetTypeName()

const StringPiece google_games_api::RoomParticipant::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_games_api::RoomParticipant

◆ has_auto_matched()

bool google_games_api::RoomParticipant::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::RoomParticipant::has_auto_matched_player ( ) const

inline

Determine if the 'autoMatchedPlayer' attribute was set.

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

◆ has_capabilities()

bool google_games_api::RoomParticipant::has_capabilities ( ) const

inline

Determine if the 'capabilities' attribute was set.

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

◆ has_client_address()

bool google_games_api::RoomParticipant::has_client_address ( ) const

inline

Determine if the 'clientAddress' attribute was set.

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

◆ has_connected()

bool google_games_api::RoomParticipant::has_connected ( ) const

inline

Determine if the 'connected' attribute was set.

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

◆ has_id()

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

inline

Determine if the 'kind' attribute was set.

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

◆ has_leave_reason()

bool google_games_api::RoomParticipant::has_leave_reason ( ) const

inline

Determine if the 'leaveReason' attribute was set.

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

◆ has_player()

bool google_games_api::RoomParticipant::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::RoomParticipant::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::RoomParticipant::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_capabilities()

client::JsonCppArray<string > google_games_api::RoomParticipant::mutable_capabilities ( )

inline

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

The capabilities which can be used when communicating with this participant.

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

◆ mutable_clientAddress()

RoomClientAddress google_games_api::RoomParticipant::mutable_clientAddress ( )

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

Client address for the participant.

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

◆ mutable_player()

Player google_games_api::RoomParticipant::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()

RoomParticipant * google_games_api::RoomParticipant::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_auto_matched()

void google_games_api::RoomParticipant::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_connected()

void google_games_api::RoomParticipant::set_connected ( bool value )

inline

Change the 'connected' attribute.

True if this participant is in the fully connected set of peers in the room.

Parameters

[in] value The new value.

◆ set_id()

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

inline

Change the 'id' attribute.

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

Parameters

[in] value The new value.

◆ set_kind()

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

inline

Change the 'kind' attribute.

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

Parameters

[in] value The new value.

◆ set_leave_reason()

void google_games_api::RoomParticipant::set_leave_reason ( const StringPiece & value )

inline

Change the 'leaveReason' attribute.

The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT. Possible values are:

"PLAYER_LEFT": The player explicitly chose to leave the room.
"GAME_LEFT": The game chose to remove the player from the room.
"ABANDONED": The player switched to another application and abandoned the room.
"PEER_CONNECTION_FAILURE": The client was unable to establish or maintain a connection to other peer(s) in the room.
"SERVER_ERROR": The client received an error response when it tried to communicate with the server.
"TIMEOUT": The client timed out while waiting for players to join and connect.
"PRESENCE_FAILURE": The client's XMPP connection ended abruptly.

Parameters

[in] value The new value.

◆ set_status()

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

inline

Change the 'status' attribute.

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

"PARTICIPANT_INVITED": The participant has been invited to join the room, but has not yet responded.
"PARTICIPANT_JOINED": The participant has joined the room (either after creating it or accepting an invitation.).
"PARTICIPANT_DECLINED": The participant declined an invitation to join the room.
"PARTICIPANT_LEFT": The participant joined the room and then left it.

Parameters

[in] value The new value.

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

google/games_api/room_participant.h
google/games_api/room_participant.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RoomParticipant() [1/2]

◆ RoomParticipant() [2/2]

◆ ~RoomParticipant()

Member Function Documentation

◆ clear_auto_matched()

◆ clear_auto_matched_player()

◆ clear_capabilities()

◆ clear_client_address()

◆ clear_connected()

◆ clear_id()

◆ clear_kind()

◆ clear_leave_reason()

◆ clear_player()

◆ clear_status()

◆ get_auto_matched()

◆ get_auto_matched_player()

◆ get_capabilities()

◆ get_client_address()

◆ get_connected()

◆ get_id()

◆ get_kind()

◆ get_leave_reason()

◆ get_player()

◆ get_status()

◆ GetTypeName()

◆ has_auto_matched()

◆ has_auto_matched_player()

◆ has_capabilities()

◆ has_client_address()

◆ has_connected()

◆ has_id()

◆ has_kind()

◆ has_leave_reason()

◆ has_player()

◆ has_status()

◆ mutable_autoMatchedPlayer()

◆ mutable_capabilities()

◆ mutable_clientAddress()

◆ mutable_player()

◆ New()

◆ set_auto_matched()

◆ set_connected()

◆ set_id()

◆ set_kind()

◆ set_leave_reason()

◆ set_status()