Documentation

Google_Service_AndroidEnterprise_Resource_Devices extends Google_Service_Resource
in package

The "devices" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
forceReportUpload()  : mixed
Uploads a report containing any changes in app states on the device since the last report was generated. You can call this method up to 3 times every 24 hours for a given device. If you exceed the quota, then the Google Play EMM API returns HTTP 429 Too Many Requests. (devices.forceReportUpload)
get()  : Google_Service_AndroidEnterprise_Device
Retrieves the details of a device. (devices.get)
getState()  : Google_Service_AndroidEnterprise_DeviceState
Retrieves whether a device's access to Google services is enabled or disabled. 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. This is only supported for Google-managed users. (devices.getState)
listDevices()  : Google_Service_AndroidEnterprise_DevicesListResponse
Retrieves the IDs of all of a user's devices. (devices.listDevices)
setState()  : Google_Service_AndroidEnterprise_DeviceState
Sets whether a device's access to Google services is enabled or disabled. 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. This is only supported for Google-managed users. (devices.setState)
update()  : Google_Service_AndroidEnterprise_Device
Updates the device policy (devices.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

forceReportUpload()

Uploads a report containing any changes in app states on the device since the last report was generated. You can call this method up to 3 times every 24 hours for a given device. If you exceed the quota, then the Google Play EMM API returns HTTP 429 Too Many Requests. (devices.forceReportUpload)

public forceReportUpload(string $enterpriseId, string $userId, string $deviceId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$enterpriseId : string

The ID of the enterprise.

$userId : string

The ID of the user.

$deviceId : string

The ID of the device.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed

get()

Retrieves the details of a device. (devices.get)

public get(string $enterpriseId, string $userId, string $deviceId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_Device
Parameters
$enterpriseId : string

The ID of the enterprise.

$userId : string

The ID of the user.

$deviceId : string

The ID of the device.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AndroidEnterprise_Device

getState()

Retrieves whether a device's access to Google services is enabled or disabled. 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. This is only supported for Google-managed users. (devices.getState)

public getState(string $enterpriseId, string $userId, string $deviceId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_DeviceState
Parameters
$enterpriseId : string

The ID of the enterprise.

$userId : string

The ID of the user.

$deviceId : string

The ID of the device.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AndroidEnterprise_DeviceState

listDevices()

Retrieves the IDs of all of a user's devices. (devices.listDevices)

public listDevices(string $enterpriseId, string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_DevicesListResponse
Parameters
$enterpriseId : string

The ID of the enterprise.

$userId : string

The ID of the user.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AndroidEnterprise_DevicesListResponse

setState()

Sets whether a device's access to Google services is enabled or disabled. 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. This is only supported for Google-managed users. (devices.setState)

public setState(string $enterpriseId, string $userId, string $deviceId, Google_Service_AndroidEnterprise_DeviceState $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_DeviceState
Parameters
$enterpriseId : string

The ID of the enterprise.

$userId : string

The ID of the user.

$deviceId : string

The ID of the device.

$postBody : Google_Service_AndroidEnterprise_DeviceState
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AndroidEnterprise_DeviceState

update()

Updates the device policy (devices.update)

public update(string $enterpriseId, string $userId, string $deviceId, Google_Service_AndroidEnterprise_Device $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_Device
Parameters
$enterpriseId : string

The ID of the enterprise.

$userId : string

The ID of the user.

$deviceId : string

The ID of the device.

$postBody : Google_Service_AndroidEnterprise_Device
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=,,...

Return values
Google_Service_AndroidEnterprise_Device

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results