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

The "devices" collection of methods. More...

Inheritance diagram for Google_Service_AndroidEnterprise_Devices_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($enterpriseId, $userId, $deviceId, $optParams=array())
 Retrieves the details of a device.
 
 getState ($enterpriseId, $userId, $deviceId, $optParams=array())
 Retrieves whether a device is enabled or disabled for access by the user to Google services.
 
 listDevices ($enterpriseId, $userId, $optParams=array())
 Retrieves the IDs of all of a user's devices.
 
 setState ($enterpriseId, $userId, $deviceId, Google_Service_AndroidEnterprise_DeviceState $postBody, $optParams=array())
 Sets whether a device is enabled or disabled for access by the user to Google services.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "devices" collection of methods.

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

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_AndroidEnterprise_Devices_Resource::get ( $enterpriseId,
$userId,
$deviceId,
$optParams = array() )

Retrieves the details of a device.

(devices.get)

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

◆ getState()

Google_Service_AndroidEnterprise_Devices_Resource::getState ( $enterpriseId,
$userId,
$deviceId,
$optParams = array() )

Retrieves whether a device is enabled or disabled for access by the user to Google services.

The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. (devices.getState)

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

◆ listDevices()

Google_Service_AndroidEnterprise_Devices_Resource::listDevices ( $enterpriseId,
$userId,
$optParams = array() )

Retrieves the IDs of all of a user's devices.

(devices.listDevices)

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

◆ setState()

Google_Service_AndroidEnterprise_Devices_Resource::setState ( $enterpriseId,
$userId,
$deviceId,
Google_Service_AndroidEnterprise_DeviceState $postBody,
$optParams = array() )

Sets whether a device is enabled or disabled for access by the user to Google services.

The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. (devices.setState)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$userIdThe ID of the user.
string$deviceIdThe ID of the device.
Google_DeviceState$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_DeviceState

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