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

The "accountUserLinks" collection of methods. More...

Inheritance diagram for Google_Service_Analytics_ManagementAccountUserLinks_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($accountId, $linkId, $optParams=array())
 Removes a user from the given account.
 
 insert ($accountId, Google_Service_Analytics_EntityUserLink $postBody, $optParams=array())
 Adds a new user to the given account.
 
 listManagementAccountUserLinks ($accountId, $optParams=array())
 Lists account-user links for a given account.
 
 update ($accountId, $linkId, Google_Service_Analytics_EntityUserLink $postBody, $optParams=array())
 Updates permissions for an existing user on the given account.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "accountUserLinks" collection of methods.

Typical usage is: $analyticsService = new Google_Service_Analytics(...); $accountUserLinks = $analyticsService->accountUserLinks;

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

◆ delete()

Google_Service_Analytics_ManagementAccountUserLinks_Resource::delete ( $accountId,
$linkId,
$optParams = array() )

Removes a user from the given account.

(accountUserLinks.delete)

Parameters
string$accountIdAccount ID to delete the user link for.
string$linkIdLink ID to delete the user link for.
array$optParamsOptional parameters.

◆ insert()

Google_Service_Analytics_ManagementAccountUserLinks_Resource::insert ( $accountId,
Google_Service_Analytics_EntityUserLink $postBody,
$optParams = array() )

Adds a new user to the given account.

(accountUserLinks.insert)

Parameters
string$accountIdAccount ID to create the user link for.
Google_EntityUserLink$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_EntityUserLink

◆ listManagementAccountUserLinks()

Google_Service_Analytics_ManagementAccountUserLinks_Resource::listManagementAccountUserLinks ( $accountId,
$optParams = array() )

Lists account-user links for a given account.

(accountUserLinks.listManagementAccountUserLinks)

Parameters
string$accountIdAccount ID to retrieve the user links for.
array$optParamsOptional parameters.

@opt_param int max-results The maximum number of account-user links to include in this response. @opt_param int start-index An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max- results parameter.

Return values
Google_Service_Analytics_EntityUserLinks

◆ update()

Google_Service_Analytics_ManagementAccountUserLinks_Resource::update ( $accountId,
$linkId,
Google_Service_Analytics_EntityUserLink $postBody,
$optParams = array() )

Updates permissions for an existing user on the given account.

(accountUserLinks.update)

Parameters
string$accountIdAccount ID to update the account-user link for.
string$linkIdLink ID to update the account-user link for.
Google_EntityUserLink$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_EntityUserLink

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