Documentation

Google_Service_CloudIdentity_Resource_Devices extends Google_Service_Resource
in package

The "devices" collection of methods.

Typical usage is: $cloudidentityService = new Google_Service_CloudIdentity(...); $devices = $cloudidentityService->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.
cancelWipe()  : Google_Service_CloudIdentity_Operation
Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. This operation is possible when the device is in a "pending wipe" state. The device enters the "pending wipe" state when a wipe device command is issued, but has not yet been sent to the device. The cancel wipe will fail if the wipe command has already been issued to the device.
create()  : Google_Service_CloudIdentity_Operation
Creates a device. Only company-owned device may be created. (devices.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudIdentity_Operation
Deletes the specified device. (devices.delete)
get()  : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1Device
Retrieves the specified device. (devices.get)
listDevices()  : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1ListDevicesResponse
Lists/Searches devices. (devices.listDevices)
wipe()  : Google_Service_CloudIdentity_Operation
Wipes all data on the specified device. (devices.wipe)
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 —

cancelWipe()

Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. This operation is possible when the device is in a "pending wipe" state. The device enters the "pending wipe" state when a wipe device command is issued, but has not yet been sent to the device. The cancel wipe will fail if the wipe command has already been issued to the device.

public cancelWipe(string $name, Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_Operation

(devices.cancelWipe)

Parameters
$name : string

Required. Resource name of the Device in format: devices/{device_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

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

Optional parameters.

Return values
Google_Service_CloudIdentity_Operation —

create()

Creates a device. Only company-owned device may be created. (devices.create)

public create(Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1Device $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_Operation
Parameters
$postBody : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1Device
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string customer Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.

Return values
Google_Service_CloudIdentity_Operation —

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 the specified device. (devices.delete)

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

Required. Resource name of the Device in format: devices/{device_id}, where device_id is the unique ID assigned to the Device.

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

Optional parameters.

Tags
opt_param

string customer Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.

Return values
Google_Service_CloudIdentity_Operation —

get()

Retrieves the specified device. (devices.get)

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

Required. Resource name of the Device in the format: devices/{device_id}, where device_id is the unique ID assigned to the Device.

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

Optional parameters.

Tags
opt_param

string customer Required. Resource name of the Customer in the format: customers/{customer_id}, where customer_id is the customer to whom the device belongs. If you're using this API for your own organization, use customers/my_customer. If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.

Return values
Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1Device —

listDevices()

Lists/Searches devices. (devices.listDevices)

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

Optional parameters.

Tags
opt_param

string pageToken Optional. A page token, received from a previous ListDevices call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDevices must match the call that provided the page token.

opt_param

string orderBy Optional. Order specification for devices in the response. Only one of the following field names may be used to specify the order: create_time, last_sync_time, model, os_version, device_type and serial_number. desc may be specified optionally at the end to specify results to be sorted in descending order. Default order is ascending.

opt_param

string filter Optional. Additional restrictions when fetching list of devices. Help Center article link

opt_param

string view Optional. The view to use for the List request.

opt_param

int pageSize Optional. The maximum number of Devices to return. If unspecified, at most 20 Devices will be returned. The maximum value is 100; values above 100 will be coerced to 100.

opt_param

string customer Required. Resource name of the customer in the format: customers/{customer_id}, where customer_id is the customer to whom the device belongs. If you're using this API for your own organization, use customers/my_customer. If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.

Return values
Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1ListDevicesResponse —

wipe()

Wipes all data on the specified device. (devices.wipe)

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

Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

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

Optional parameters.

Return values
Google_Service_CloudIdentity_Operation —

convertToArrayAndStripNulls()

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

Search results