#include <room.h>

Inheritance diagram for google_games_api::Room:

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

	Room (Json::Value *storage)

virtual	~Room ()

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 RoomAutoMatchingCriteria	get_auto_matching_criteria () const

RoomAutoMatchingCriteria	mutable_autoMatchingCriteria ()

bool	has_auto_matching_status () const

void	clear_auto_matching_status ()

const RoomAutoMatchStatus	get_auto_matching_status () const

RoomAutoMatchStatus	mutable_autoMatchingStatus ()

bool	has_creation_details () const

void	clear_creation_details ()

const RoomModification	get_creation_details () const

RoomModification	mutable_creationDetails ()

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 RoomModification	get_last_update_details () const

RoomModification	mutable_lastUpdateDetails ()

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

void	clear_room_status_version ()

int32	get_room_status_version () const

void	set_room_status_version (int32 value)

bool	has_status () const

void	clear_status ()

const StringPiece	get_status () const

void	set_status (const StringPiece &value)

bool	has_variant () const

void	clear_variant ()

int32	get_variant () const

void	set_variant (int32 value)

Static Public Member Functions
static Room *	New ()

Detailed Description

This is a JSON template for a room resource object.

Constructor & Destructor Documentation

◆ Room() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ Room() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~Room()

google_games_api::Room::~Room ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_application_id()

void google_games_api::Room::clear_application_id ( )

inline

Clears the 'applicationId' attribute.

◆ clear_auto_matching_criteria()

void google_games_api::Room::clear_auto_matching_criteria ( )

inline

Clears the 'autoMatchingCriteria' attribute.

◆ clear_auto_matching_status()

void google_games_api::Room::clear_auto_matching_status ( )

inline

Clears the 'autoMatchingStatus' attribute.

◆ clear_creation_details()

void google_games_api::Room::clear_creation_details ( )

inline

Clears the 'creationDetails' attribute.

◆ clear_description()

void google_games_api::Room::clear_description ( )

inline

Clears the 'description' attribute.

◆ clear_inviter_id()

void google_games_api::Room::clear_inviter_id ( )

inline

Clears the 'inviterId' attribute.

◆ clear_kind()

void google_games_api::Room::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_last_update_details()

void google_games_api::Room::clear_last_update_details ( )

inline

Clears the 'lastUpdateDetails' attribute.

◆ clear_participants()

void google_games_api::Room::clear_participants ( )

inline

Clears the 'participants' attribute.

◆ clear_room_id()

void google_games_api::Room::clear_room_id ( )

inline

Clears the 'roomId' attribute.

◆ clear_room_status_version()

void google_games_api::Room::clear_room_status_version ( )

inline

Clears the 'roomStatusVersion' attribute.

◆ clear_status()

void google_games_api::Room::clear_status ( )

inline

Clears the 'status' attribute.

◆ clear_variant()

void google_games_api::Room::clear_variant ( )

inline

Clears the 'variant' attribute.

◆ get_application_id()

const StringPiece google_games_api::Room::get_application_id ( ) const

inline

Get the value of the 'applicationId' attribute.

◆ get_auto_matching_criteria()

const RoomAutoMatchingCriteria google_games_api::Room::get_auto_matching_criteria ( ) const

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

◆ get_auto_matching_status()

const RoomAutoMatchStatus google_games_api::Room::get_auto_matching_status ( ) const

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

◆ get_creation_details()

const RoomModification google_games_api::Room::get_creation_details ( ) const

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

◆ get_description()

const StringPiece google_games_api::Room::get_description ( ) const

inline

Get the value of the 'description' attribute.

◆ get_inviter_id()

const StringPiece google_games_api::Room::get_inviter_id ( ) const

inline

Get the value of the 'inviterId' attribute.

◆ get_kind()

const StringPiece google_games_api::Room::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_last_update_details()

const RoomModification google_games_api::Room::get_last_update_details ( ) const

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

◆ get_participants()

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

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

◆ get_room_id()

const StringPiece google_games_api::Room::get_room_id ( ) const

inline

Get the value of the 'roomId' attribute.

◆ get_room_status_version()

int32 google_games_api::Room::get_room_status_version ( ) const

inline

Get the value of the 'roomStatusVersion' attribute.

◆ get_status()

const StringPiece google_games_api::Room::get_status ( ) const

inline

Get the value of the 'status' attribute.

◆ get_variant()

int32 google_games_api::Room::get_variant ( ) const

inline

Get the value of the 'variant' attribute.

◆ GetTypeName()

const StringPiece google_games_api::Room::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_games_api::Room

◆ has_application_id()

bool google_games_api::Room::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::Room::has_auto_matching_criteria ( ) const

inline

Determine if the 'autoMatchingCriteria' attribute was set.

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

◆ has_auto_matching_status()

bool google_games_api::Room::has_auto_matching_status ( ) const

inline

Determine if the 'autoMatchingStatus' attribute was set.

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

◆ has_creation_details()

bool google_games_api::Room::has_creation_details ( ) const

inline

Determine if the 'creationDetails' attribute was set.

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

◆ has_description()

bool google_games_api::Room::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::Room::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::Room::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::Room::has_last_update_details ( ) const

inline

Determine if the 'lastUpdateDetails' attribute was set.

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

◆ has_participants()

bool google_games_api::Room::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::Room::has_room_id ( ) const

inline

Determine if the 'roomId' attribute was set.

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

◆ has_room_status_version()

bool google_games_api::Room::has_room_status_version ( ) const

inline

Determine if the 'roomStatusVersion' attribute was set.

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

◆ has_status()

bool google_games_api::Room::has_status ( ) const

inline

Determine if the 'status' attribute was set.

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

◆ has_variant()

bool google_games_api::Room::has_variant ( ) const

inline

Determine if the 'variant' attribute was set.

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

◆ mutable_autoMatchingCriteria()

RoomAutoMatchingCriteria google_games_api::Room::mutable_autoMatchingCriteria ( )

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

Criteria for auto-matching players into this room.

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

◆ mutable_autoMatchingStatus()

RoomAutoMatchStatus google_games_api::Room::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 auto-matching queue.

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

◆ mutable_creationDetails()

RoomModification google_games_api::Room::mutable_creationDetails ( )

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

Details about the room creation.

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

◆ mutable_lastUpdateDetails()

RoomModification google_games_api::Room::mutable_lastUpdateDetails ( )

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

Details about the last update to the room.

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

◆ mutable_participants()

client::JsonCppArray<RoomParticipant > google_games_api::Room::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()

Room * google_games_api::Room::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_application_id()

void google_games_api::Room::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::Room::set_description ( const StringPiece & value )

inline

Change the 'description' attribute.

This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.).

Parameters

[in] value The new value.

◆ set_inviter_id()

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

inline

Change the 'inviterId' attribute.

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

Parameters

[in] value The new value.

◆ set_kind()

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

inline

Change the 'kind' attribute.

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

Parameters

[in] value The new value.

◆ set_room_id()

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

inline

Change the 'roomId' attribute.

Globally unique ID for a room.

Parameters

[in] value The new value.

◆ set_room_status_version()

void google_games_api::Room::set_room_status_version ( int32 value )

inline

Change the 'roomStatusVersion' attribute.

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

Parameters

[in] value The new value.

◆ set_status()

void google_games_api::Room::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 and are connecting to each other (either before or after auto-matching).
"ROOM_ACTIVE": All players have joined and connected to each other.
"ROOM_DELETED": The room should no longer be shown on the client.

Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.

Parameters

[in] value The new value.

◆ set_variant()

void google_games_api::Room::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.

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

google/games_api/room.h
google/games_api/room.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Room() [1/2]

◆ Room() [2/2]

◆ ~Room()

Member Function Documentation

◆ clear_application_id()

◆ clear_auto_matching_criteria()

◆ clear_auto_matching_status()

◆ clear_creation_details()

◆ clear_description()

◆ clear_inviter_id()

◆ clear_kind()

◆ clear_last_update_details()

◆ clear_participants()

◆ clear_room_id()

◆ clear_room_status_version()

◆ clear_status()

◆ clear_variant()

◆ get_application_id()

◆ get_auto_matching_criteria()

◆ get_auto_matching_status()

◆ get_creation_details()

◆ get_description()

◆ get_inviter_id()

◆ get_kind()

◆ get_last_update_details()

◆ get_participants()

◆ get_room_id()

◆ get_room_status_version()

◆ get_status()

◆ get_variant()

◆ GetTypeName()

◆ has_application_id()

◆ has_auto_matching_criteria()

◆ has_auto_matching_status()

◆ has_creation_details()

◆ has_description()

◆ has_inviter_id()

◆ has_kind()

◆ has_last_update_details()

◆ has_participants()

◆ has_room_id()

◆ has_room_status_version()

◆ has_status()

◆ has_variant()

◆ mutable_autoMatchingCriteria()

◆ mutable_autoMatchingStatus()

◆ mutable_creationDetails()

◆ mutable_lastUpdateDetails()

◆ mutable_participants()

◆ New()

◆ set_application_id()

◆ set_description()

◆ set_inviter_id()

◆ set_kind()

◆ set_room_id()

◆ set_room_status_version()

◆ set_status()

◆ set_variant()