Documentation

Google_Service_Games_Resource_Players extends Google_Service_Resource
in package

The "players" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Games_Player
Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set `playerId` to `me`. (players.get)
listPlayers()  : Google_Service_Games_PlayerListResponse
Get the collection of players for the currently authenticated user.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

get()

Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set `playerId` to `me`. (players.get)

public get(string $playerId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_Player
Parameters
$playerId : string

A player ID. A value of me may be used in place of the authenticated player's ID.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

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

Return values
Google_Service_Games_Player —

listPlayers()

Get the collection of players for the currently authenticated user.

public listPlayers(string $collection[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_PlayerListResponse

(players.listPlayers)

Parameters
$collection : string

Collection of players being retrieved

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

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

opt_param

int maxResults The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults.

opt_param

string pageToken The token returned by the previous request.

Return values
Google_Service_Games_PlayerListResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results