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

The "users" collection of methods. More...

Inheritance diagram for Google_Service_AndroidEnterprise_Users_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 generateToken ($enterpriseId, $userId, $optParams=array())
 Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard.
 
 get ($enterpriseId, $userId, $optParams=array())
 Retrieves a user's details.
 
 getAvailableProductSet ($enterpriseId, $userId, $optParams=array())
 Retrieves the set of products a user is entitled to access.
 
 listUsers ($enterpriseId, $email, $optParams=array())
 Looks up a user by email address.
 
 revokeToken ($enterpriseId, $userId, $optParams=array())
 Revokes a previously generated token (activation code) for the user.
 
 setAvailableProductSet ($enterpriseId, $userId, Google_Service_AndroidEnterprise_ProductSet $postBody, $optParams=array())
 Modifies the set of products a user is entitled to access.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "users" collection of methods.

Typical usage is: $androidenterpriseService = new Google_Service_AndroidEnterprise(...); $users = $androidenterpriseService->users;

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

◆ generateToken()

Google_Service_AndroidEnterprise_Users_Resource::generateToken ( $enterpriseId,
$userId,
$optParams = array() )

Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard.

Revokes any previously generated token. (users.generateToken)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$userIdThe ID of the user.
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_UserToken

◆ get()

Google_Service_AndroidEnterprise_Users_Resource::get ( $enterpriseId,
$userId,
$optParams = array() )

Retrieves a user's details.

(users.get)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$userIdThe ID of the user.
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_User

◆ getAvailableProductSet()

Google_Service_AndroidEnterprise_Users_Resource::getAvailableProductSet ( $enterpriseId,
$userId,
$optParams = array() )

Retrieves the set of products a user is entitled to access.

(users.getAvailableProductSet)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$userIdThe ID of the user.
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_ProductSet

◆ listUsers()

Google_Service_AndroidEnterprise_Users_Resource::listUsers ( $enterpriseId,
$email,
$optParams = array() )

Looks up a user by email address.

(users.listUsers)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$emailThe exact primary email address of the user to look up.
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_UsersListResponse

◆ revokeToken()

Google_Service_AndroidEnterprise_Users_Resource::revokeToken ( $enterpriseId,
$userId,
$optParams = array() )

Revokes a previously generated token (activation code) for the user.

(users.revokeToken)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$userIdThe ID of the user.
array$optParamsOptional parameters.

◆ setAvailableProductSet()

Google_Service_AndroidEnterprise_Users_Resource::setAvailableProductSet ( $enterpriseId,
$userId,
Google_Service_AndroidEnterprise_ProductSet $postBody,
$optParams = array() )

Modifies the set of products a user is entitled to access.

(users.setAvailableProductSet)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$userIdThe ID of the user.
Google_ProductSet$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_ProductSet

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