Documentation

Google_Service_AndroidManagement_Resource_EnterprisesDevices extends Google_Service_Resource
in package

The "devices" collection of methods.

Typical usage is: $androidmanagementService = new Google_Service_AndroidManagement(...); $devices = $androidmanagementService->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.
delete()  : Google_Service_AndroidManagement_AndroidmanagementEmpty
Deletes a device. This operation wipes the device. (devices.delete)
get()  : Google_Service_AndroidManagement_Device
Gets a device. (devices.get)
issueCommand()  : Google_Service_AndroidManagement_Operation
Issues a command to a device. The Operation resource returned contains a Command in its metadata field. Use the get operation method to get the status of the command. (devices.issueCommand)
listEnterprisesDevices()  : Google_Service_AndroidManagement_ListDevicesResponse
Lists devices for a given enterprise. (devices.listEnterprisesDevices)
patch()  : Google_Service_AndroidManagement_Device
Updates a device. (devices.patch)
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

delete()

Deletes a device. This operation wipes the device. (devices.delete)

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidManagement_AndroidmanagementEmpty
Parameters
$name : string

The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.

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

Optional parameters.

Tags
opt_param

string wipeDataFlags Optional flags that control the device wiping behavior.

opt_param

string wipeReasonMessage Optional. A short message displayed to the user before wiping the work profile on personal devices. This has no effect on company owned devices. The maximum message length is 200 characters.

Return values
Google_Service_AndroidManagement_AndroidmanagementEmpty —

issueCommand()

Issues a command to a device. The Operation resource returned contains a Command in its metadata field. Use the get operation method to get the status of the command. (devices.issueCommand)

public issueCommand(string $name, Google_Service_AndroidManagement_Command $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidManagement_Operation
Parameters
$name : string

The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.

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

Optional parameters.

Return values
Google_Service_AndroidManagement_Operation —

listEnterprisesDevices()

Lists devices for a given enterprise. (devices.listEnterprisesDevices)

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

The name of the enterprise in the form enterprises/{enterpriseId}.

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

Optional parameters.

Tags
opt_param

int pageSize The requested page size. The actual page size may be fixed to a min or max value.

opt_param

string pageToken A token identifying a page of results returned by the server.

Return values
Google_Service_AndroidManagement_ListDevicesResponse —

patch()

Updates a device. (devices.patch)

public patch(string $name, Google_Service_AndroidManagement_Device $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidManagement_Device
Parameters
$name : string

The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.

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

Optional parameters.

Tags
opt_param

string updateMask The field mask indicating the fields to update. If not set, all modifiable fields will be modified.

Return values
Google_Service_AndroidManagement_Device —

convertToArrayAndStripNulls()

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

Search results