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

The "tokens" collection of methods. More...

Inheritance diagram for Google_Service_Directory_Tokens_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($userKey, $clientId, $optParams=array())
 Delete all access tokens issued by a user for an application.
 
 get ($userKey, $clientId, $optParams=array())
 Get information about an access token issued by a user.
 
 listTokens ($userKey, $optParams=array())
 Returns the set of tokens specified user has issued to 3rd party applications.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "tokens" collection of methods.

Typical usage is: $adminService = new Google_Service_Directory(...); $tokens = $adminService->tokens;

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_Directory_Tokens_Resource::delete ( $userKey,
$clientId,
$optParams = array() )

Delete all access tokens issued by a user for an application.

(tokens.delete)

Parameters
string$userKeyIdentifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
string$clientIdThe Client ID of the application the token is issued to.
array$optParamsOptional parameters.

◆ get()

Google_Service_Directory_Tokens_Resource::get ( $userKey,
$clientId,
$optParams = array() )

Get information about an access token issued by a user.

(tokens.get)

Parameters
string$userKeyIdentifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
string$clientIdThe Client ID of the application the token is issued to.
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Token

◆ listTokens()

Google_Service_Directory_Tokens_Resource::listTokens ( $userKey,
$optParams = array() )

Returns the set of tokens specified user has issued to 3rd party applications.

(tokens.listTokens)

Parameters
string$userKeyIdentifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Tokens

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