Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Reports_Activities_Resource Class Reference

The "activities" collection of methods. More...

Inheritance diagram for Google_Service_Reports_Activities_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 listActivities ($userKey, $applicationName, $optParams=array())
 Retrieves a list of activities for a specific customer and application.
 
 watch ($userKey, $applicationName, Google_Service_Reports_Channel $postBody, $optParams=array())
 Push changes to activities (activities.watch)
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "activities" collection of methods.

Typical usage is: $adminService = new Google_Service_Reports(...); $activities = $adminService->activities;

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

◆ listActivities()

Google_Service_Reports_Activities_Resource::listActivities ( $userKey,
$applicationName,
$optParams = array() )

Retrieves a list of activities for a specific customer and application.

(activities.listActivities)

Parameters
string$userKeyRepresents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.
string$applicationNameApplication name for which the events are to be retrieved.
array$optParamsOptional parameters.

@opt_param string startTime Return events which occured at or after this time. @opt_param string actorIpAddress IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. @opt_param int maxResults Number of activity records to be shown in each page. @opt_param string eventName Name of the event being queried. @opt_param string pageToken Token to specify next page. @opt_param string filters Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],... @opt_param string endTime Return events which occured at or before this time. @opt_param string customerId Represents the customer for which the data is to be fetched.

Return values
Google_Service_Reports_Activities

◆ watch()

Google_Service_Reports_Activities_Resource::watch ( $userKey,
$applicationName,
Google_Service_Reports_Channel $postBody,
$optParams = array() )

Push changes to activities (activities.watch)

Parameters
string$userKeyRepresents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.
string$applicationNameApplication name for which the events are to be retrieved.
Google_Channel$postBody
array$optParamsOptional parameters.

@opt_param string startTime Return events which occured at or after this time. @opt_param string actorIpAddress IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. @opt_param int maxResults Number of activity records to be shown in each page. @opt_param string eventName Name of the event being queried. @opt_param string pageToken Token to specify next page. @opt_param string filters Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],... @opt_param string endTime Return events which occured at or before this time. @opt_param string customerId Represents the customer for which the data is to be fetched.

Return values
Google_Service_Reports_Channel

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