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

The "accountUserProfiles" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_AccountUserProfiles_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($profileId, $id, $optParams=array())
 Gets one account user profile by ID.
 
 insert ($profileId, Google_Service_Dfareporting_AccountUserProfile $postBody, $optParams=array())
 Inserts a new account user profile.
 
 listAccountUserProfiles ($profileId, $optParams=array())
 Retrieves a list of account user profiles, possibly filtered.
 
 patch ($profileId, $id, Google_Service_Dfareporting_AccountUserProfile $postBody, $optParams=array())
 Updates an existing account user profile.
 
 update ($profileId, Google_Service_Dfareporting_AccountUserProfile $postBody, $optParams=array())
 Updates an existing account user profile.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "accountUserProfiles" collection of methods.

Typical usage is: $dfareportingService = new Google_Service_Dfareporting(...); $accountUserProfiles = $dfareportingService->accountUserProfiles;

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

◆ get()

Google_Service_Dfareporting_AccountUserProfiles_Resource::get ( $profileId,
$id,
$optParams = array() )

Gets one account user profile by ID.

(accountUserProfiles.get)

Parameters
string$profileIdUser profile ID associated with this request.
string$idUser profile ID.
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_AccountUserProfile

◆ insert()

Google_Service_Dfareporting_AccountUserProfiles_Resource::insert ( $profileId,
Google_Service_Dfareporting_AccountUserProfile $postBody,
$optParams = array() )

Inserts a new account user profile.

(accountUserProfiles.insert)

Parameters
string$profileIdUser profile ID associated with this request.
Google_AccountUserProfile$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_AccountUserProfile

◆ listAccountUserProfiles()

Google_Service_Dfareporting_AccountUserProfiles_Resource::listAccountUserProfiles ( $profileId,
$optParams = array() )

Retrieves a list of account user profiles, possibly filtered.

(accountUserProfiles.listAccountUserProfiles)

Parameters
string$profileIdUser profile ID associated with this request.
array$optParamsOptional parameters.

@opt_param string searchString Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". @opt_param string subaccountId Select only user profiles with the specified subaccount ID. @opt_param string sortField Field by which to sort the list. @opt_param string ids Select only user profiles with these IDs. @opt_param int maxResults Maximum number of results to return. @opt_param string pageToken Value of the nextPageToken from the previous result page. @opt_param string userRoleId Select only user profiles with the specified user role ID. @opt_param string sortOrder Order of sorted results, default is ASCENDING. @opt_param bool active Select only active user profiles.

Return values
Google_Service_Dfareporting_AccountUserProfilesListResponse

◆ patch()

Google_Service_Dfareporting_AccountUserProfiles_Resource::patch ( $profileId,
$id,
Google_Service_Dfareporting_AccountUserProfile $postBody,
$optParams = array() )

Updates an existing account user profile.

This method supports patch semantics. (accountUserProfiles.patch)

Parameters
string$profileIdUser profile ID associated with this request.
string$idUser profile ID.
Google_AccountUserProfile$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_AccountUserProfile

◆ update()

Google_Service_Dfareporting_AccountUserProfiles_Resource::update ( $profileId,
Google_Service_Dfareporting_AccountUserProfile $postBody,
$optParams = array() )

Updates an existing account user profile.

(accountUserProfiles.update)

Parameters
string$profileIdUser profile ID associated with this request.
Google_AccountUserProfile$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_AccountUserProfile

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