Devices
class Devices extends Resource (View source)
The "devices" collection of methods.
Typical usage is:
$homegraphService = new Google\Service\HomeGraphService(...);
$devices = $homegraphService->devices;Methods
Gets the current states in Home Graph for the given set of the third-party
user's devices. The third-party user's identity is passed in via the
agent_user_id (see QueryRequest). This request must be authorized using
service account credentials from your Actions console project.
Reports device state and optionally sends device notifications. Called by
your smart home Action when the state of a third-party device changes or you
need to send a notification about the device. See Implement Report
State for more information. This method updates the device state according
to its declared traits. Publishing a new state value outside
of these traits will result in an INVALID_ARGUMENT error response. The
third-party user's identity is passed in via the agent_user_id (see
ReportStateAndNotificationRequest). This request must be authorized using
service account credentials from your Actions console project.
Requests Google to send an action.devices.SYNC
intent to
your smart home Action to update device metadata for the given user. The
third-party user's identity is passed via the agent_user_id (see
RequestSyncDevicesRequest). This request must be authorized using service
account credentials from your Actions console project. (devices.requestSync)
Gets all the devices associated with the given third-party user. The third-
party user's identity is passed in via the agent_user_id (see SyncRequest).
Details
QueryResponse
query(QueryRequest $postBody, array $optParams = [])
Gets the current states in Home Graph for the given set of the third-party
user's devices. The third-party user's identity is passed in via the
agent_user_id (see QueryRequest). This request must be authorized using
service account credentials from your Actions console project.
(devices.query)
ReportStateAndNotificationResponse
reportStateAndNotification(ReportStateAndNotificationRequest $postBody, array $optParams = [])
Reports device state and optionally sends device notifications. Called by
your smart home Action when the state of a third-party device changes or you
need to send a notification about the device. See Implement Report
State for more information. This method updates the device state according
to its declared traits. Publishing a new state value outside
of these traits will result in an INVALID_ARGUMENT error response. The
third-party user's identity is passed in via the agent_user_id (see
ReportStateAndNotificationRequest). This request must be authorized using
service account credentials from your Actions console project.
(devices.reportStateAndNotification)
RequestSyncDevicesResponse
requestSync(RequestSyncDevicesRequest $postBody, array $optParams = [])
Requests Google to send an action.devices.SYNC
intent to
your smart home Action to update device metadata for the given user. The
third-party user's identity is passed via the agent_user_id (see
RequestSyncDevicesRequest). This request must be authorized using service
account credentials from your Actions console project. (devices.requestSync)
SyncResponse
sync(SyncRequest $postBody, array $optParams = [])
Gets all the devices associated with the given third-party user. The third-
party user's identity is passed in via the agent_user_id (see SyncRequest).
This request must be authorized using service account credentials from your Actions console project. (devices.sync)