games  v1
Public Member Functions | Static Public Member Functions | List of all members
google_games_api::RoomCreateRequest Class Reference

#include <room_create_request.h>

Inheritance diagram for google_games_api::RoomCreateRequest:

Public Member Functions

 RoomCreateRequest (const Json::Value &storage)
 
 RoomCreateRequest (Json::Value *storage)
 
virtual ~RoomCreateRequest ()
 
const StringPiece GetTypeName () const
 
bool has_auto_matching_criteria () const
 
void clear_auto_matching_criteria ()
 
const RoomAutoMatchingCriteria get_auto_matching_criteria () const
 
RoomAutoMatchingCriteria mutable_autoMatchingCriteria ()
 
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_invited_player_ids () const
 
void clear_invited_player_ids ()
 
const client::JsonCppArray< string > get_invited_player_ids () const
 
client::JsonCppArray< string > mutable_invitedPlayerIds ()
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_network_diagnostics () const
 
void clear_network_diagnostics ()
 
const NetworkDiagnostics get_network_diagnostics () const
 
NetworkDiagnostics mutable_networkDiagnostics ()
 
bool has_request_id () const
 
void clear_request_id ()
 
int64 get_request_id () const
 
void set_request_id (int64 value)
 
bool has_variant () const
 
void clear_variant ()
 
int32 get_variant () const
 
void set_variant (int32 value)
 

Static Public Member Functions

static RoomCreateRequestNew ()
 

Detailed Description

This is a JSON template for a room creation request.

Constructor & Destructor Documentation

◆ RoomCreateRequest() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ RoomCreateRequest() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~RoomCreateRequest()

google_games_api::RoomCreateRequest::~RoomCreateRequest ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_auto_matching_criteria()

void google_games_api::RoomCreateRequest::clear_auto_matching_criteria ( )
inline

Clears the 'autoMatchingCriteria' attribute.

◆ clear_capabilities()

void google_games_api::RoomCreateRequest::clear_capabilities ( )
inline

Clears the 'capabilities' attribute.

◆ clear_client_address()

void google_games_api::RoomCreateRequest::clear_client_address ( )
inline

Clears the 'clientAddress' attribute.

◆ clear_invited_player_ids()

void google_games_api::RoomCreateRequest::clear_invited_player_ids ( )
inline

Clears the 'invitedPlayerIds' attribute.

◆ clear_kind()

void google_games_api::RoomCreateRequest::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_network_diagnostics()

void google_games_api::RoomCreateRequest::clear_network_diagnostics ( )
inline

Clears the 'networkDiagnostics' attribute.

◆ clear_request_id()

void google_games_api::RoomCreateRequest::clear_request_id ( )
inline

Clears the 'requestId' attribute.

◆ clear_variant()

void google_games_api::RoomCreateRequest::clear_variant ( )
inline

Clears the 'variant' attribute.

◆ get_auto_matching_criteria()

const RoomAutoMatchingCriteria google_games_api::RoomCreateRequest::get_auto_matching_criteria ( ) const

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

◆ get_capabilities()

const client::JsonCppArray<string > google_games_api::RoomCreateRequest::get_capabilities ( ) const
inline

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

◆ get_client_address()

const RoomClientAddress google_games_api::RoomCreateRequest::get_client_address ( ) const

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

◆ get_invited_player_ids()

const client::JsonCppArray<string > google_games_api::RoomCreateRequest::get_invited_player_ids ( ) const
inline

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

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_network_diagnostics()

const NetworkDiagnostics google_games_api::RoomCreateRequest::get_network_diagnostics ( ) const

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

◆ get_request_id()

int64 google_games_api::RoomCreateRequest::get_request_id ( ) const
inline

Get the value of the 'requestId' attribute.

◆ get_variant()

int32 google_games_api::RoomCreateRequest::get_variant ( ) const
inline

Get the value of the 'variant' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_games_api::RoomCreateRequest

◆ has_auto_matching_criteria()

bool google_games_api::RoomCreateRequest::has_auto_matching_criteria ( ) const
inline

Determine if the 'autoMatchingCriteria' attribute was set.

Returns
true if the 'autoMatchingCriteria' attribute was set.

◆ has_capabilities()

bool google_games_api::RoomCreateRequest::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::RoomCreateRequest::has_client_address ( ) const
inline

Determine if the 'clientAddress' attribute was set.

Returns
true if the 'clientAddress' attribute was set.

◆ has_invited_player_ids()

bool google_games_api::RoomCreateRequest::has_invited_player_ids ( ) const
inline

Determine if the 'invitedPlayerIds' attribute was set.

Returns
true if the 'invitedPlayerIds' attribute was set.

◆ has_kind()

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

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_network_diagnostics()

bool google_games_api::RoomCreateRequest::has_network_diagnostics ( ) const
inline

Determine if the 'networkDiagnostics' attribute was set.

Returns
true if the 'networkDiagnostics' attribute was set.

◆ has_request_id()

bool google_games_api::RoomCreateRequest::has_request_id ( ) const
inline

Determine if the 'requestId' attribute was set.

Returns
true if the 'requestId' attribute was set.

◆ has_variant()

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

client::JsonCppArray<string > google_games_api::RoomCreateRequest::mutable_capabilities ( )
inline

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

The capabilities that this client supports for realtime communication.

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

◆ mutable_clientAddress()

RoomClientAddress google_games_api::RoomCreateRequest::mutable_clientAddress ( )

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

Client address for the player creating the room.

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

◆ mutable_invitedPlayerIds()

client::JsonCppArray<string > google_games_api::RoomCreateRequest::mutable_invitedPlayerIds ( )
inline

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

The player IDs to invite to the room.

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

◆ mutable_networkDiagnostics()

NetworkDiagnostics google_games_api::RoomCreateRequest::mutable_networkDiagnostics ( )

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

Network diagnostics for the client creating the room.

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

◆ New()

RoomCreateRequest * google_games_api::RoomCreateRequest::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_kind()

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

Change the 'kind' attribute.

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

Parameters
[in]valueThe new value.

◆ set_request_id()

void google_games_api::RoomCreateRequest::set_request_id ( int64  value)
inline

Change the 'requestId' attribute.

A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries.

Parameters
[in]valueThe new value.

◆ set_variant()

void google_games_api::RoomCreateRequest::set_variant ( int32  value)
inline

Change the 'variant' attribute.

The variant / mode of the application to be played. This can be any integer value, or left blank. You should use a small number of variants to keep the auto-matching pool as large as possible.

Parameters
[in]valueThe new value.

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