Google_Service_GamesManagement_Resource_Events
extends Google_Service_Resource
in package
The "events" collection of methods.
Typical usage is:
$gamesManagementService = new Google_Service_GamesManagement(...);
$events = $gamesManagementService->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.
- reset() : mixed
- Resets all player progress on the event with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. (events.reset)
- resetAll() : mixed
- Resets all player progress on all events for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. (events.resetAll)
- resetAllForAllPlayers() : mixed
- Resets all draft events for all players. This method is only available to user accounts for your developer console. (events.resetAllForAllPlayers)
- resetForAllPlayers() : mixed
- Resets the event with the given ID for all players. This method is only available to user accounts for your developer console. Only draft events can be reset. (events.resetForAllPlayers)
- resetMultipleForAllPlayers() : mixed
- Resets events with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft events may be reset. (events.resetMultipleForAllPlayers)
- convertToArrayAndStripNulls() : mixed
Properties
$client
private
Google_Client
$client
$methods
private
array<string|int, mixed>
$methods
$resourceName
private
string
$resourceName
$rootUrl
private
string
$rootUrl
$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
Tags
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
Return values
string —$requestUrl
reset()
Resets all player progress on the event with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. (events.reset)
public
reset(string $eventId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
- $eventId : string
-
The ID of the event.
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
mixed —resetAll()
Resets all player progress on all events for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. (events.resetAll)
public
resetAll([array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
mixed —resetAllForAllPlayers()
Resets all draft events for all players. This method is only available to user accounts for your developer console. (events.resetAllForAllPlayers)
public
resetAllForAllPlayers([array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
mixed —resetForAllPlayers()
Resets the event with the given ID for all players. This method is only available to user accounts for your developer console. Only draft events can be reset. (events.resetForAllPlayers)
public
resetForAllPlayers(string $eventId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
- $eventId : string
-
The ID of the event.
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
mixed —resetMultipleForAllPlayers()
Resets events with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft events may be reset. (events.resetMultipleForAllPlayers)
public
resetMultipleForAllPlayers(Google_Service_GamesManagement_EventsResetMultipleForAllRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
- $postBody : Google_Service_GamesManagement_EventsResetMultipleForAllRequest
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
mixed —convertToArrayAndStripNulls()
protected
convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
- $o : mixed