Liking cljdoc? Tell your friends :D

happygapi.homegraph.devices

HomeGraph API: devices.

See: https://developers.google.com/actions/smarthome/create-app#request-syncapi/reference/rest/v1/devices
raw docstring

query$clj

(query$ auth parameters body)

https://developers.google.com/actions/smarthome/create-app#request-syncapi/reference/rest/v1/devices/query

Required parameters: none

Optional parameters: none

Body:

{:requestId string, :inputs [{:payload QueryRequestPayload}], :agentUserId string}

Gets the device states for the devices in QueryRequest. The third-party user's identity is passed in as agent_user_id. The agent is identified by the JWT signed by the third-party partner's service account.

https://developers.google.com/actions/smarthome/create-app#request-syncapi/reference/rest/v1/devices/query

Required parameters: none

Optional parameters: none

Body: 

{:requestId string,
 :inputs [{:payload QueryRequestPayload}],
 :agentUserId string}

Gets the device states for the devices in QueryRequest.
The third-party user's identity is passed in as `agent_user_id`. The agent
is identified by the JWT signed by the third-party partner's service
account.
sourceraw docstring

reportStateAndNotification$clj

(reportStateAndNotification$ auth parameters body)

https://developers.google.com/actions/smarthome/create-app#request-syncapi/reference/rest/v1/devices/reportStateAndNotification

Required parameters: none

Optional parameters: none

Body:

{:eventId string, :agentUserId string, :payload {:devices ReportStateAndNotificationDevice}, :requestId string, :followUpToken string}

Reports device state and optionally sends device notifications. Called by an agent when the device state of a third-party changes or the agent wants to send a notification about the device. See Implement Report State for more information. This method updates a predefined set of states for a device, which all devices have according to their prescribed traits (for example, a light will have the OnOff trait that reports the state on as a boolean value). A new state may not be created and an INVALID_ARGUMENT code will be thrown if so. It also optionally takes in a list of Notifications that may be created, which are associated to this state change.

The third-party user's identity is passed in as agent_user_id. The agent is identified by the JWT signed by the partner's service account.

https://developers.google.com/actions/smarthome/create-app#request-syncapi/reference/rest/v1/devices/reportStateAndNotification

Required parameters: none

Optional parameters: none

Body: 

{:eventId string,
 :agentUserId string,
 :payload {:devices ReportStateAndNotificationDevice},
 :requestId string,
 :followUpToken string}

Reports device state and optionally sends device notifications. Called by
an agent when the device state of a third-party changes or the agent wants
to send a notification about the device. See
[Implement Report State](/actions/smarthome/report-state) for more
information.
This method updates a predefined set of states for a device, which all
devices have according to their prescribed traits (for example, a light
will have the [OnOff](/actions/smarthome/traits/onoff) trait that reports
the state `on` as a boolean value).
A new state may not be created and an INVALID_ARGUMENT code will be thrown
if so. It also optionally takes in a list of Notifications that may be
created, which are associated to this state change.

The third-party user's identity is passed in as `agent_user_id`.
The agent is identified by the JWT signed by the partner's service account.
sourceraw docstring

requestSync$clj

(requestSync$ auth parameters body)

https://developers.google.com/actions/smarthome/create-app#request-syncapi/reference/rest/v1/devices/requestSync

Required parameters: none

Optional parameters: none

Body:

{:agentUserId string, :async boolean}

Requests a SYNC call from Google to a 3p partner's home control agent for a user.

The third-party user's identity is passed in as agent_user_id (see RequestSyncDevicesRequest) and forwarded back to the agent. The agent is identified by the API key or JWT signed by the partner's service account.

https://developers.google.com/actions/smarthome/create-app#request-syncapi/reference/rest/v1/devices/requestSync

Required parameters: none

Optional parameters: none

Body: 

{:agentUserId string, :async boolean}

Requests a `SYNC` call from Google to a 3p partner's home control agent for
a user.


The third-party user's identity is passed in as `agent_user_id`
(see RequestSyncDevicesRequest) and forwarded back to the agent.
The agent is identified by the API key or JWT signed by the partner's
service account.
sourceraw docstring

sync$clj

(sync$ auth parameters body)

https://developers.google.com/actions/smarthome/create-app#request-syncapi/reference/rest/v1/devices/sync

Required parameters: none

Optional parameters: none

Body:

{:requestId string, :agentUserId string}

Gets all the devices associated with the given third-party user. The third-party user's identity is passed in as agent_user_id. The agent is identified by the JWT signed by the third-party partner's service account.

https://developers.google.com/actions/smarthome/create-app#request-syncapi/reference/rest/v1/devices/sync

Required parameters: none

Optional parameters: none

Body: 

{:requestId string, :agentUserId string}

Gets all the devices associated with the given third-party user.
The third-party user's identity is passed in as `agent_user_id`. The agent
is identified by the JWT signed by the third-party partner's service
account.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close