#include <room_status.h>

Inheritance diagram for google_games_api::RoomStatus:

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

	RoomStatus (Json::Value *storage)

virtual	~RoomStatus ()

const StringPiece	GetTypeName () const

bool	has_auto_matching_status () const

void	clear_auto_matching_status ()

const RoomAutoMatchStatus	get_auto_matching_status () const

RoomAutoMatchStatus	mutable_autoMatchingStatus ()

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_participants () const

void	clear_participants ()

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

client::JsonCppArray< RoomParticipant >	mutable_participants ()

bool	has_room_id () const

void	clear_room_id ()

const StringPiece	get_room_id () const

void	set_room_id (const StringPiece &value)

bool	has_status () const

void	clear_status ()

const StringPiece	get_status () const

void	set_status (const StringPiece &value)

bool	has_status_version () const

void	clear_status_version ()

int32	get_status_version () const

void	set_status_version (int32 value)

Static Public Member Functions
static RoomStatus *	New ()

Detailed Description

This is a JSON template for the status of a room that the player has joined.

Constructor & Destructor Documentation

◆ RoomStatus() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ RoomStatus() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~RoomStatus()

google_games_api::RoomStatus::~RoomStatus ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_auto_matching_status()

void google_games_api::RoomStatus::clear_auto_matching_status ( )

inline

Clears the 'autoMatchingStatus' attribute.

◆ clear_kind()

void google_games_api::RoomStatus::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_participants()

void google_games_api::RoomStatus::clear_participants ( )

inline

Clears the 'participants' attribute.

◆ clear_room_id()

void google_games_api::RoomStatus::clear_room_id ( )

inline

Clears the 'roomId' attribute.

◆ clear_status()

void google_games_api::RoomStatus::clear_status ( )

inline

Clears the 'status' attribute.

◆ clear_status_version()

void google_games_api::RoomStatus::clear_status_version ( )

inline

Clears the 'statusVersion' attribute.

◆ get_auto_matching_status()

const RoomAutoMatchStatus google_games_api::RoomStatus::get_auto_matching_status ( ) const

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

◆ get_kind()

const StringPiece google_games_api::RoomStatus::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_participants()

const client::JsonCppArray<RoomParticipant > google_games_api::RoomStatus::get_participants ( ) const

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

◆ get_room_id()

const StringPiece google_games_api::RoomStatus::get_room_id ( ) const

inline

Get the value of the 'roomId' attribute.

◆ get_status()

const StringPiece google_games_api::RoomStatus::get_status ( ) const

inline

Get the value of the 'status' attribute.

◆ get_status_version()

int32 google_games_api::RoomStatus::get_status_version ( ) const

inline

Get the value of the 'statusVersion' attribute.

◆ GetTypeName()

const StringPiece google_games_api::RoomStatus::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_games_api::RoomStatus

◆ has_auto_matching_status()

bool google_games_api::RoomStatus::has_auto_matching_status ( ) const

inline

Determine if the 'autoMatchingStatus' attribute was set.

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

◆ has_kind()

bool google_games_api::RoomStatus::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

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

◆ has_participants()

bool google_games_api::RoomStatus::has_participants ( ) const

inline

Determine if the 'participants' attribute was set.

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

◆ has_room_id()

bool google_games_api::RoomStatus::has_room_id ( ) const

inline

Determine if the 'roomId' attribute was set.

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

◆ has_status()

bool google_games_api::RoomStatus::has_status ( ) const

inline

Determine if the 'status' attribute was set.

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

◆ has_status_version()

bool google_games_api::RoomStatus::has_status_version ( ) const

inline

Determine if the 'statusVersion' attribute was set.

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

◆ mutable_autoMatchingStatus()

RoomAutoMatchStatus google_games_api::RoomStatus::mutable_autoMatchingStatus ( )

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

Auto-matching status for this room. Not set if the room is not currently in the automatching queue.

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

◆ mutable_participants()

client::JsonCppArray<RoomParticipant > google_games_api::RoomStatus::mutable_participants ( )

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

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

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

◆ New()

RoomStatus * google_games_api::RoomStatus::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_kind()

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

inline

Change the 'kind' attribute.

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

Parameters

[in] value The new value.

◆ set_room_id()

void google_games_api::RoomStatus::set_room_id ( const StringPiece & value )

inline

Change the 'roomId' attribute.

Globally unique ID for a room.

Parameters

[in] value The new value.

◆ set_status()

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

inline

Change the 'status' attribute.

The status of the room. Possible values are:

"ROOM_INVITING": One or more players have been invited and not responded.
"ROOM_AUTO_MATCHING": One or more slots need to be filled by auto-matching.
"ROOM_CONNECTING": Players have joined are connecting to each other (either before or after auto-matching).
"ROOM_ACTIVE": All players have joined and connected to each other.
"ROOM_DELETED": All joined players have left.

Parameters

[in] value The new value.

◆ set_status_version()

void google_games_api::RoomStatus::set_status_version ( int32 value )

inline

Change the 'statusVersion' attribute.

The version of the status for the room: an increasing counter, used by the client to ignore out-of-order updates to room status.

Parameters

[in] value The new value.

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

google/games_api/room_status.h
google/games_api/room_status.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RoomStatus() [1/2]

◆ RoomStatus() [2/2]

◆ ~RoomStatus()

Member Function Documentation

◆ clear_auto_matching_status()

◆ clear_kind()

◆ clear_participants()

◆ clear_room_id()

◆ clear_status()

◆ clear_status_version()

◆ get_auto_matching_status()

◆ get_kind()

◆ get_participants()

◆ get_room_id()

◆ get_status()

◆ get_status_version()

◆ GetTypeName()

◆ has_auto_matching_status()

◆ has_kind()

◆ has_participants()

◆ has_room_id()

◆ has_status()

◆ has_status_version()

◆ mutable_autoMatchingStatus()

◆ mutable_participants()

◆ New()

◆ set_kind()

◆ set_room_id()

◆ set_status()

◆ set_status_version()