Google_Service_Games_Rooms_Resource Class Reference

The "rooms" collection of methods. More...

Inheritance diagram for Google_Service_Games_Rooms_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	create (Google_Service_Games_RoomCreateRequest $postBody, $optParams=array())
	Create a room.
	decline ($roomId, $optParams=array())
	Decline an invitation to join a room.
	dismiss ($roomId, $optParams=array())
	Dismiss an invitation to join a room.
	get ($roomId, $optParams=array())
	Get the data for a room.
	join ($roomId, Google_Service_Games_RoomJoinRequest $postBody, $optParams=array())
	Join a room.
	leave ($roomId, Google_Service_Games_RoomLeaveRequest $postBody, $optParams=array())
	Leave a room.
	listRooms ($optParams=array())
	Returns invitations to join rooms.
	reportStatus ($roomId, Google_Service_Games_RoomP2PStatuses $postBody, $optParams=array())
	Updates sent by a client reporting the status of peers in a room.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "rooms" collection of methods.

Typical usage is: $gamesService = new Google_Service_Games(...); $rooms = $gamesService->rooms;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

create()

Google_Service_Games_Rooms_Resource::create	(	Google_Service_Games_RoomCreateRequest	$postBody,
			$optParams = array() )

Create a room.

For internal use by the Games SDK only. Calling this method directly is unsupported. (rooms.create)

Parameters

Google_RoomCreateRequest	$postBody
array	$optParams	Optional parameters.

@opt_param string language The preferred language to use for strings returned by this method.

Return values

Google_Service_Games_Room

decline()

Google_Service_Games_Rooms_Resource::decline	(		$roomId,
			$optParams = array() )

Decline an invitation to join a room.

For internal use by the Games SDK only. Calling this method directly is unsupported. (rooms.decline)

Parameters

string	$roomId	The ID of the room.
array	$optParams	Optional parameters.

@opt_param string language The preferred language to use for strings returned by this method.

Return values

Google_Service_Games_Room

dismiss()

Google_Service_Games_Rooms_Resource::dismiss	(		$roomId,
			$optParams = array() )

Dismiss an invitation to join a room.

For internal use by the Games SDK only. Calling this method directly is unsupported. (rooms.dismiss)

Parameters

string	$roomId	The ID of the room.
array	$optParams	Optional parameters.

get()

Google_Service_Games_Rooms_Resource::get	(		$roomId,
			$optParams = array() )

Get the data for a room.

(rooms.get)

Parameters

string	$roomId	The ID of the room.
array	$optParams	Optional parameters.

@opt_param string language The preferred language to use for strings returned by this method.

Return values

Google_Service_Games_Room

join()

Google_Service_Games_Rooms_Resource::join	(		$roomId,
		Google_Service_Games_RoomJoinRequest	$postBody,
			$optParams = array() )

Join a room.

For internal use by the Games SDK only. Calling this method directly is unsupported. (rooms.join)

Parameters

string	$roomId	The ID of the room.
Google_RoomJoinRequest	$postBody
array	$optParams	Optional parameters.

@opt_param string language The preferred language to use for strings returned by this method.

Return values

Google_Service_Games_Room

leave()

Google_Service_Games_Rooms_Resource::leave	(		$roomId,
		Google_Service_Games_RoomLeaveRequest	$postBody,
			$optParams = array() )

Leave a room.

For internal use by the Games SDK only. Calling this method directly is unsupported. (rooms.leave)

Parameters

string	$roomId	The ID of the room.
Google_RoomLeaveRequest	$postBody
array	$optParams	Optional parameters.

@opt_param string language The preferred language to use for strings returned by this method.

Return values

Google_Service_Games_Room

listRooms()

Google_Service_Games_Rooms_Resource::listRooms

(

$optParams = array()

)

Returns invitations to join rooms.

(rooms.listRooms)

Parameters

array

$optParams

Optional parameters.

@opt_param string pageToken The token returned by the previous request. @opt_param int maxResults The maximum number of rooms to return in the response, used for paging. For any response, the actual number of rooms to return may be less than the specified maxResults. @opt_param string language The preferred language to use for strings returned by this method.

Return values

Google_Service_Games_RoomList

reportStatus()

Google_Service_Games_Rooms_Resource::reportStatus	(		$roomId,
		Google_Service_Games_RoomP2PStatuses	$postBody,
			$optParams = array() )

Updates sent by a client reporting the status of peers in a room.

For internal use by the Games SDK only. Calling this method directly is unsupported. (rooms.reportStatus)

Parameters

string	$roomId	The ID of the room.
Google_RoomP2PStatuses	$postBody
array	$optParams	Optional parameters.

@opt_param string language The preferred language to use for strings returned by this method.

Return values

Google_Service_Games_RoomStatus

---

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

• lib/google/src/Google/Service/Games.php