Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_GamesManagement_Events_Resource Class Reference

The "events" collection of methods. More...

Inheritance diagram for Google_Service_GamesManagement_Events_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 reset ($eventId, $optParams=array())
 Resets all player progress on the event with the given ID for the currently authenticated player.
 
 resetAll ($optParams=array())
 Resets all player progress on all events for the currently authenticated player.
 
 resetAllForAllPlayers ($optParams=array())
 Resets all draft events for all players.
 
 resetForAllPlayers ($eventId, $optParams=array())
 Resets the event with the given ID for all players.
 
 resetMultipleForAllPlayers (Google_Service_GamesManagement_EventsResetMultipleForAllRequest $postBody, $optParams=array())
 Resets events with the given IDs for all players.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "events" collection of methods.

Typical usage is: $gamesManagementService = new Google_Service_GamesManagement(...); $events = $gamesManagementService->events;

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

◆ reset()

Google_Service_GamesManagement_Events_Resource::reset ( $eventId,
$optParams = array() )

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. All quests for this player that use the event will also be reset. (events.reset)

Parameters
string$eventIdThe ID of the event.
array$optParamsOptional parameters.

◆ resetAll()

Google_Service_GamesManagement_Events_Resource::resetAll ( $optParams = array())

Resets all player progress on all events for the currently authenticated player.

This method is only accessible to whitelisted tester accounts for your application. All quests for this player will also be reset. (events.resetAll)

Parameters
array$optParamsOptional parameters.

◆ resetAllForAllPlayers()

Google_Service_GamesManagement_Events_Resource::resetAllForAllPlayers ( $optParams = array())

Resets all draft events for all players.

This method is only available to user accounts for your developer console. All quests that use any of these events will also be reset. (events.resetAllForAllPlayers)

Parameters
array$optParamsOptional parameters.

◆ resetForAllPlayers()

Google_Service_GamesManagement_Events_Resource::resetForAllPlayers ( $eventId,
$optParams = array() )

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. All quests that use the event will also be reset. (events.resetForAllPlayers)

Parameters
string$eventIdThe ID of the event.
array$optParamsOptional parameters.

◆ resetMultipleForAllPlayers()

Google_Service_GamesManagement_Events_Resource::resetMultipleForAllPlayers ( Google_Service_GamesManagement_EventsResetMultipleForAllRequest $postBody,
$optParams = array() )

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. All quests that use any of the events will also be reset. (events.resetMultipleForAllPlayers)

Parameters
Google_EventsResetMultipleForAllRequest$postBody
array$optParamsOptional parameters.

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