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

The "userStates" collection of methods. More...

Inheritance diagram for Google_Service_Partners_UserStates_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 listUserStates ($optParams=array())
 Lists states for current user.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "userStates" collection of methods.

Typical usage is: $partnersService = new Google_Service_Partners(...); $userStates = $partnersService->userStates;

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

◆ listUserStates()

Google_Service_Partners_UserStates_Resource::listUserStates ( $optParams = array())

Lists states for current user.

(userStates.listUserStates)

Parameters
array$optParamsOptional parameters.

@opt_param string requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID. @opt_param string requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. @opt_param string requestMetadata.partnersSessionId Google Partners session ID. @opt_param string requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. @opt_param string requestMetadata.locale Locale to use for the current request. @opt_param string requestMetadata.experimentIds Experiment IDs the current request belongs to. @opt_param string requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

Return values
Google_Service_Partners_ListUserStatesResponse

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