Documentation

Google_Service_SmartDeviceManagement_Resource_EnterprisesDevices extends Google_Service_Resource
in package

The "devices" collection of methods.

Typical usage is: $smartdevicemanagementService = new Google_Service_SmartDeviceManagement(...); $devices = $smartdevicemanagementService->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.
executeCommand()  : Google_Service_SmartDeviceManagement_GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse
Executes a command to device managed by the enterprise.
get()  : Google_Service_SmartDeviceManagement_GoogleHomeEnterpriseSdmV1Device
Gets a device managed by the enterprise. (devices.get)
listEnterprisesDevices()  : Google_Service_SmartDeviceManagement_GoogleHomeEnterpriseSdmV1ListDevicesResponse
Lists devices managed by the enterprise. (devices.listEnterprisesDevices)
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

executeCommand()

Executes a command to device managed by the enterprise.

public executeCommand(string $name, Google_Service_SmartDeviceManagement_GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SmartDeviceManagement_GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse

(devices.executeCommand)

Parameters
$name : string

The name of the device requested. For example: "enterprises/XYZ/devices/123"

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

Optional parameters.

Return values
Google_Service_SmartDeviceManagement_GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse —

listEnterprisesDevices()

Lists devices managed by the enterprise. (devices.listEnterprisesDevices)

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

The parent enterprise to list devices under. E.g. "enterprises/XYZ".

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

Optional parameters.

Tags
opt_param

string view Additional details that need to be provided for the device.

opt_param

string filter Optional filter to list devices. Filters can match the exact assignee (could be a structure or a room). E.g. 'assignee=enterprises/XYZ/structures/abc' Also could filter by parent (group): 'parent=enterprises/XYZ/groups/jkl' or filter by device custom name (substring match): 'customName=wing'

opt_param

int pageSize Optional requested page size. Server may return fewer devices than requested. If unspecified, server will pick an appropriate default.

opt_param

string pageToken Optional token of the page to retrieve.

Return values
Google_Service_SmartDeviceManagement_GoogleHomeEnterpriseSdmV1ListDevicesResponse —

convertToArrayAndStripNulls()

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

Search results