Documentation

Google_Service_HomeGraphService_Device extends Google_Collection
in package

Extension to the regular Google_Model that automatically exposes the items array for iteration, so you can just iterate over the object rather than a reference inside.

Table of Contents

NULL_VALUE  = "{}gapi-php-null"
If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.
$attributes  : mixed
$customData  : mixed
$id  : mixed
$notificationSupportedByAgent  : mixed
$roomHint  : mixed
$structureHint  : mixed
$traits  : mixed
$type  : mixed
$willReportState  : mixed
$collection_key  : mixed
$deviceInfoDataType  : mixed
$deviceInfoType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$nameDataType  : mixed
$nameType  : mixed
$otherDeviceIdsDataType  : mixed
$otherDeviceIdsType  : mixed
$processed  : mixed
__construct()  : mixed
Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.
__get()  : mixed
Getter that handles passthrough access to the data array, and lazy object creation.
__isset()  : mixed
__unset()  : mixed
assertIsArray()  : mixed
Verify if $obj is an array.
count()  : mixed
current()  : mixed
getAttributes()  : mixed
getCustomData()  : mixed
getDeviceInfo()  : Google_Service_HomeGraphService_DeviceInfo
getId()  : mixed
getName()  : Google_Service_HomeGraphService_DeviceNames
getNotificationSupportedByAgent()  : mixed
getOtherDeviceIds()  : Google_Service_HomeGraphService_AgentOtherDeviceId
getRoomHint()  : mixed
getStructureHint()  : mixed
getTraits()  : mixed
getType()  : mixed
getWillReportState()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAttributes()  : mixed
setCustomData()  : mixed
setDeviceInfo()  : mixed
setId()  : mixed
setName()  : mixed
setNotificationSupportedByAgent()  : mixed
setOtherDeviceIds()  : mixed
setRoomHint()  : mixed
setStructureHint()  : mixed
setTraits()  : mixed
setType()  : mixed
setWillReportState()  : mixed
toSimpleObject()  : mixed
Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.
valid()  : mixed
dataType()  : mixed
gapiInit()  : mixed
Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.
isAssociativeArray()  : bool
Returns true only if the array is associative.
keyType()  : mixed
mapTypes()  : void
Initialize this object's properties from an array.
camelCase()  : string
Convert a string to camelCase
coerceType()  : mixed
getMappedName()  : mixed
If there is an internal name mapping, use that.
getSimpleValue()  : mixed
Handle different types of values, primarily other objects and map and array data types.
nullPlaceholderCheck()  : mixed
Check whether the value is the null placeholder and return true null.

Constants

NULL_VALUE

If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.

public mixed NULL_VALUE = "{}gapi-php-null"

Properties

$attributes

public mixed $attributes

$customData

public mixed $customData

$notificationSupportedByAgent

public mixed $notificationSupportedByAgent

$roomHint

public mixed $roomHint

$structureHint

public mixed $structureHint

$willReportState

public mixed $willReportState

$collection_key

protected mixed $collection_key = 'traits'

$deviceInfoDataType

protected mixed $deviceInfoDataType = ''

$deviceInfoType

protected mixed $deviceInfoType = 'Google_Service_HomeGraphService_DeviceInfo'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$nameDataType

protected mixed $nameDataType = ''

$nameType

protected mixed $nameType = 'Google_Service_HomeGraphService_DeviceNames'

$otherDeviceIdsDataType

protected mixed $otherDeviceIdsDataType = 'array'

$otherDeviceIdsType

protected mixed $otherDeviceIdsType = 'Google_Service_HomeGraphService_AgentOtherDeviceId'

$processed

protected mixed $processed = array()

Methods

__construct()

Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.

public final __construct() : mixed
Return values
mixed —

__get()

Getter that handles passthrough access to the data array, and lazy object creation.

public __get(string $key) : mixed
Parameters
$key : string

Property name.

Return values
mixed —

The value if any, or null.

__isset()

public __isset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

__unset()

public __unset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

assertIsArray()

Verify if $obj is an array.

public assertIsArray(array<string|int, mixed> $obj, string $method) : mixed
Parameters
$obj : array<string|int, mixed>

Items that should be validated.

$method : string

Method expecting an array as an argument.

Tags
throws
Google_Exception

Thrown if $obj isn't an array.

Return values
mixed —

count()

public count() : mixed
Return values
mixed —

current()

public current() : mixed
Return values
mixed —

getAttributes()

public getAttributes() : mixed
Return values
mixed —

getCustomData()

public getCustomData() : mixed
Return values
mixed —

getId()

public getId() : mixed
Return values
mixed —

getNotificationSupportedByAgent()

public getNotificationSupportedByAgent() : mixed
Return values
mixed —

getRoomHint()

public getRoomHint() : mixed
Return values
mixed —

getStructureHint()

public getStructureHint() : mixed
Return values
mixed —

getTraits()

public getTraits() : mixed
Return values
mixed —

getType()

public getType() : mixed
Return values
mixed —

getWillReportState()

public getWillReportState() : mixed
Return values
mixed —

key()

public key() : mixed
Return values
mixed —

next()

public next() : mixed
Return values
mixed —

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed —

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

rewind()

public rewind() : mixed
Return values
mixed —

setAttributes()

public setAttributes(mixed $attributes) : mixed
Parameters
$attributes : mixed
Return values
mixed —

setCustomData()

public setCustomData(mixed $customData) : mixed
Parameters
$customData : mixed
Return values
mixed —

setId()

public setId(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed —

setNotificationSupportedByAgent()

public setNotificationSupportedByAgent(mixed $notificationSupportedByAgent) : mixed
Parameters
$notificationSupportedByAgent : mixed
Return values
mixed —

setOtherDeviceIds()

public setOtherDeviceIds(mixed $otherDeviceIds) : mixed
Parameters
$otherDeviceIds : mixed
Return values
mixed —

setRoomHint()

public setRoomHint(mixed $roomHint) : mixed
Parameters
$roomHint : mixed
Return values
mixed —

setStructureHint()

public setStructureHint(mixed $structureHint) : mixed
Parameters
$structureHint : mixed
Return values
mixed —

setTraits()

public setTraits(mixed $traits) : mixed
Parameters
$traits : mixed
Return values
mixed —

setType()

public setType(mixed $type) : mixed
Parameters
$type : mixed
Return values
mixed —

setWillReportState()

public setWillReportState(mixed $willReportState) : mixed
Parameters
$willReportState : mixed
Return values
mixed —

toSimpleObject()

Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.

public toSimpleObject() : mixed
Return values
mixed —

valid()

public valid() : mixed
Return values
mixed —

dataType()

protected dataType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

gapiInit()

Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.

protected gapiInit() : mixed
Return values
mixed —

isAssociativeArray()

Returns true only if the array is associative.

protected isAssociativeArray(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>
Return values
bool —

True if the array is associative.

keyType()

protected keyType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

mapTypes()

Initialize this object's properties from an array.

protected mapTypes(array<string|int, mixed> $array) : void
Parameters
$array : array<string|int, mixed>

Used to seed this object's properties.

Return values
void —

camelCase()

Convert a string to camelCase

private camelCase(string $value) : string
Parameters
$value : string
Return values
string —

coerceType()

private coerceType(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

getMappedName()

If there is an internal name mapping, use that.

private getMappedName(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

getSimpleValue()

Handle different types of values, primarily other objects and map and array data types.

private getSimpleValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

nullPlaceholderCheck()

Check whether the value is the null placeholder and return true null.

private nullPlaceholderCheck(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

Search results