Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
Google_Service_Games_Events_Resource Class Reference

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

Inheritance diagram for Google_Service_Games_Events_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 listByPlayer ($optParams=array())
 Returns a list showing the current progress on events in this application for the currently authenticated user.
 
 listDefinitions ($optParams=array())
 Returns a list of the event definitions in this application.
 
 record (Google_Service_Games_EventRecordRequest $postBody, $optParams=array())
 Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "events" collection of methods.

Typical usage is: $gamesService = new Google_Service_Games(...); $events = $gamesService->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

◆ listByPlayer()

Google_Service_Games_Events_Resource::listByPlayer ( $optParams = array())

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

(events.listByPlayer)

Parameters
array$optParamsOptional parameters.

@opt_param string pageToken The token returned by the previous request. @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. @opt_param string language The preferred language to use for strings returned by this method.

Return values
Google_Service_Games_PlayerEventListResponse

◆ listDefinitions()

Google_Service_Games_Events_Resource::listDefinitions ( $optParams = array())

Returns a list of the event definitions in this application.

(events.listDefinitions)

Parameters
array$optParamsOptional parameters.

@opt_param string pageToken The token returned by the previous request. @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 language The preferred language to use for strings returned by this method.

Return values
Google_Service_Games_EventDefinitionListResponse

◆ record()

Google_Service_Games_Events_Resource::record ( Google_Service_Games_EventRecordRequest $postBody,
$optParams = array() )

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

(events.record)

Parameters
Google_EventRecordRequest$postBody
array$optParamsOptional parameters.

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

Return values
Google_Service_Games_EventUpdateResponse

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