google_api_home_graph v0.6.0 GoogleApi.HomeGraph.V1.Model.ReportStateAndNotificationRequest View Source

Request type for the ReportStateAndNotification call. It may include states, notifications, or both. States and notifications are defined per device_id (for example, "123" and "456" in the following example).

Example

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "agentUserId": "1234",
  "payload": {
    "devices": {
      "states": {
        "123": {
          "on": true
        },
        "456": {
          "on": true,
          "brightness": 10
        }
      },
    }
  }
}

Attributes

  • agentUserId (type: String.t, default: nil) - Required. Third-party user ID.
  • eventId (type: String.t, default: nil) - Unique identifier per event (for example, a doorbell press).
  • followUpToken (type: String.t, default: nil) - Token to maintain state in the follow up notification response. Deprecated. See the notifications guide for details on implementing follow up notifications.
  • payload (type: GoogleApi.HomeGraph.V1.Model.StateAndNotificationPayload.t, default: nil) - Required. State of devices to update and notification metadata for devices.
  • requestId (type: String.t, default: nil) - Request ID used for debugging.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.HomeGraph.V1.Model.ReportStateAndNotificationRequest{
  agentUserId: String.t(),
  eventId: String.t(),
  followUpToken: String.t(),
  payload: GoogleApi.HomeGraph.V1.Model.StateAndNotificationPayload.t(),
  requestId: String.t()
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.