google_games_api::RoomLeaveRequest Class Reference

#include <room_leave_request.h>

Inheritance diagram for google_games_api::RoomLeaveRequest:

Public Member Functions
	RoomLeaveRequest (const Json::Value &storage)
	RoomLeaveRequest (Json::Value *storage)
virtual	~RoomLeaveRequest ()
const StringPiece	GetTypeName () const
bool	has_kind () const
void	clear_kind ()
const StringPiece	get_kind () const
void	set_kind (const StringPiece &value)
bool	has_leave_diagnostics () const
void	clear_leave_diagnostics ()
const RoomLeaveDiagnostics	get_leave_diagnostics () const
RoomLeaveDiagnostics	mutable_leaveDiagnostics ()
bool	has_reason () const
void	clear_reason ()
const StringPiece	get_reason () const
void	set_reason (const StringPiece &value)

Static Public Member Functions
static RoomLeaveRequest *	New ()

Detailed Description

This is a JSON template for a leave room request.

Constructor & Destructor Documentation

RoomLeaveRequest() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

RoomLeaveRequest() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~RoomLeaveRequest()

google_games_api::RoomLeaveRequest::~RoomLeaveRequest ( )

virtual

Standard destructor.

Member Function Documentation

clear_kind()

void google_games_api::RoomLeaveRequest::clear_kind ( )

inline

Clears the 'kind' attribute.

clear_leave_diagnostics()

void google_games_api::RoomLeaveRequest::clear_leave_diagnostics ( )

inline

Clears the 'leaveDiagnostics' attribute.

clear_reason()

void google_games_api::RoomLeaveRequest::clear_reason ( )

inline

Clears the 'reason' attribute.

get_kind()

const StringPiece google_games_api::RoomLeaveRequest::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

get_leave_diagnostics()

const RoomLeaveDiagnostics google_games_api::RoomLeaveRequest::get_leave_diagnostics

(

)

const

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

get_reason()

const StringPiece google_games_api::RoomLeaveRequest::get_reason ( ) const

inline

Get the value of the 'reason' attribute.

GetTypeName()

const StringPiece google_games_api::RoomLeaveRequest::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_games_api::RoomLeaveRequest

has_kind()

bool google_games_api::RoomLeaveRequest::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns

true if the 'kind' attribute was set.

has_leave_diagnostics()

bool google_games_api::RoomLeaveRequest::has_leave_diagnostics ( ) const

inline

Determine if the 'leaveDiagnostics' attribute was set.

Returns

true if the 'leaveDiagnostics' attribute was set.

has_reason()

bool google_games_api::RoomLeaveRequest::has_reason ( ) const

inline

Determine if the 'reason' attribute was set.

Returns

true if the 'reason' attribute was set.

mutable_leaveDiagnostics()

RoomLeaveDiagnostics google_games_api::RoomLeaveRequest::mutable_leaveDiagnostics

(

)

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

Diagnostics for a player leaving the room.

Returns

The result can be modified to change the attribute value.

New()

RoomLeaveRequest * google_games_api::RoomLeaveRequest::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_kind()

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

inline

Change the 'kind' attribute.

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

Parameters

[in]

value

The new value.

set_reason()

void google_games_api::RoomLeaveRequest::set_reason ( const StringPiece &  value )

inline

Change the 'reason' attribute.

Reason for leaving the match. Possible values are:

"PLAYER_LEFT"

The player chose to leave the room..

"GAME_LEFT"

The game chose to remove the player from the room.

"REALTIME_ABANDONED"

The player switched to another application and abandoned the room.

"REALTIME_PEER_CONNECTION_FAILURE"

The client was unable to establish a connection to other peer(s).

"REALTIME_SERVER_CONNECTION_FAILURE"

The client was unable to communicate with the server.

"REALTIME_SERVER_ERROR"

The client received an error response when it tried to communicate with the server.

"REALTIME_TIMEOUT"

The client timed out while waiting for a room.

"REALTIME_CLIENT_DISCONNECTING"

The client disconnects without first calling Leave.

"REALTIME_SIGN_OUT"

The user signed out of G+ while in the room.

"REALTIME_GAME_CRASHED"

The game crashed.

"REALTIME_ROOM_SERVICE_CRASHED"

RoomAndroidService crashed.

"REALTIME_DIFFERENT_CLIENT_ROOM_OPERATION"

Another client is trying to enter a room.

"REALTIME_SAME_CLIENT_ROOM_OPERATION"

The same client is trying to enter a new room.

Parameters

[in]

value

The new value.

---

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

• google/games_api/room_leave_request.h
• google/games_api/room_leave_request.cc