Documentation

Google_Service_Games_Resource_Events extends Google_Service_Resource
in package

The "events" collection of methods.

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

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.
listByPlayer()  : Google_Service_Games_PlayerEventListResponse
Returns a list showing the current progress on events in this application for the currently authenticated user. (events.listByPlayer)
listDefinitions()  : Google_Service_Games_EventDefinitionListResponse
Returns a list of the event definitions in this application.
record()  : Google_Service_Games_EventUpdateResponse
Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application. (events.record)
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

listByPlayer()

Returns a list showing the current progress on events in this application for the currently authenticated user. (events.listByPlayer)

public listByPlayer([array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_PlayerEventListResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken The token returned by the previous request.

opt_param

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

opt_param

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

Return values
Google_Service_Games_PlayerEventListResponse —

listDefinitions()

Returns a list of the event definitions in this application.

public listDefinitions([array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_EventDefinitionListResponse

(events.listDefinitions)

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

Optional parameters.

Tags
opt_param

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

opt_param

string pageToken The token returned by the previous request.

opt_param

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

Return values
Google_Service_Games_EventDefinitionListResponse —

record()

Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application. (events.record)

public record(Google_Service_Games_EventRecordRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_EventUpdateResponse
Parameters
$postBody : Google_Service_Games_EventRecordRequest
$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_EventUpdateResponse —

convertToArrayAndStripNulls()

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

Search results