Documentation

Google_Service_AndroidProvisioningPartner_Resource_CustomersDevices extends Google_Service_Resource
in package

The "devices" collection of methods.

Typical usage is: $androiddeviceprovisioningService = new Google_Service_AndroidProvisioningPartner(...); $devices = $androiddeviceprovisioningService->devices;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
applyConfiguration()  : Google_Service_AndroidProvisioningPartner_AndroiddeviceprovisioningEmpty
Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_AndroidProvisioningPartner_Device
Gets the details of a device. (devices.get)
listCustomersDevices()  : Google_Service_AndroidProvisioningPartner_CustomerListDevicesResponse
Lists a customer's devices. (devices.listCustomersDevices)
removeConfiguration()  : Google_Service_AndroidProvisioningPartner_AndroiddeviceprovisioningEmpty
Removes a configuration from device. (devices.removeConfiguration)
unclaim()  : Google_Service_AndroidProvisioningPartner_AndroiddeviceprovisioningEmpty
Unclaims a device from a customer and removes it from zero-touch enrollment.
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

applyConfiguration()

Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset.

public applyConfiguration(string $parent, Google_Service_AndroidProvisioningPartner_CustomerApplyConfigurationRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidProvisioningPartner_AndroiddeviceprovisioningEmpty

(devices.applyConfiguration)

Parameters
$parent : string

Required. The customer managing the device. An API resource name in the format customers/[CUSTOMER_ID].

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

Optional parameters.

Return values
Google_Service_AndroidProvisioningPartner_AndroiddeviceprovisioningEmpty

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

listCustomersDevices()

Lists a customer's devices. (devices.listCustomersDevices)

public listCustomersDevices(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidProvisioningPartner_CustomerListDevicesResponse
Parameters
$parent : string

Required. The customer managing the devices. An API resource name in the format customers/[CUSTOMER_ID].

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

Optional parameters.

Tags
opt_param

string pageToken A token specifying which result page to return.

opt_param

string pageSize The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.

Return values
Google_Service_AndroidProvisioningPartner_CustomerListDevicesResponse

removeConfiguration()

Removes a configuration from device. (devices.removeConfiguration)

public removeConfiguration(string $parent, Google_Service_AndroidProvisioningPartner_CustomerRemoveConfigurationRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidProvisioningPartner_AndroiddeviceprovisioningEmpty
Parameters
$parent : string

Required. The customer managing the device in the format customers/[CUSTOMER_ID].

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

Optional parameters.

Return values
Google_Service_AndroidProvisioningPartner_AndroiddeviceprovisioningEmpty

unclaim()

Unclaims a device from a customer and removes it from zero-touch enrollment.

public unclaim(string $parent, Google_Service_AndroidProvisioningPartner_CustomerUnclaimDeviceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidProvisioningPartner_AndroiddeviceprovisioningEmpty

After removing a device, a customer must contact their reseller to register the device into zero-touch enrollment again. (devices.unclaim)

Parameters
$parent : string

Required. The customer managing the device. An API resource name in the format customers/[CUSTOMER_ID].

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

Optional parameters.

Return values
Google_Service_AndroidProvisioningPartner_AndroiddeviceprovisioningEmpty

convertToArrayAndStripNulls()

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

Search results