Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
Google_Service_Directory_VerificationCodes_Resource Class Reference

The "verificationCodes" collection of methods. More...

Inheritance diagram for Google_Service_Directory_VerificationCodes_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 generate ($userKey, $optParams=array())
 Generate new backup verification codes for the user.
 
 invalidate ($userKey, $optParams=array())
 Invalidate the current backup verification codes for the user.
 
 listVerificationCodes ($userKey, $optParams=array())
 Returns the current set of valid backup verification codes for the specified user.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "verificationCodes" collection of methods.

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

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

◆ generate()

Google_Service_Directory_VerificationCodes_Resource::generate ( $userKey,
$optParams = array() )

Generate new backup verification codes for the user.

(verificationCodes.generate)

Parameters
string$userKeyEmail or immutable Id of the user
array$optParamsOptional parameters.

◆ invalidate()

Google_Service_Directory_VerificationCodes_Resource::invalidate ( $userKey,
$optParams = array() )

Invalidate the current backup verification codes for the user.

(verificationCodes.invalidate)

Parameters
string$userKeyEmail or immutable Id of the user
array$optParamsOptional parameters.

◆ listVerificationCodes()

Google_Service_Directory_VerificationCodes_Resource::listVerificationCodes ( $userKey,
$optParams = array() )

Returns the current set of valid backup verification codes for the specified user.

(verificationCodes.listVerificationCodes)

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_VerificationCodes

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