GoogleAssistantAccessoryV1DeviceState

AI Overview😉

  • The potential purpose of this module is to understand the state of a device and its capabilities, such as alarms, timers, fitness activities, and installed apps, in order to provide more accurate and personalized responses to user requests. It helps the Assistant to know what the device can do and what its current state is, allowing for more effective fulfillment of requests.
  • This module could impact search results by allowing the Assistant to provide more relevant and accurate information based on the device's capabilities and state. For example, if a user asks about setting an alarm, the Assistant can provide instructions specific to the device's alarm capabilities. It could also impact the ranking of search results by favoring results that are more relevant to the device's capabilities and state.
  • A website may change things to be more favorable for this function by providing clear and accurate information about the device's capabilities and state, such as its alarm and timer settings, fitness activities, and installed apps. This could include providing structured data about the device's features and capabilities, as well as ensuring that the website is optimized for the device's specific characteristics and limitations. Additionally, the website could provide information about the device's location and time zone to help the Assistant provide more accurate and relevant results.

Interesting Module? Vote 👇

Voting helps other researchers find interesting modules.

Current Votes: 0

GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantAccessoryV1DeviceState (google_api_content_warehouse v0.4.0)

Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 13

Attributes

  • alarmState (type: GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantEmbeddedV1Alarms.t, default: nil) - Optional Information about on-device alarms. For devices that support alarms, all on-device alarms must be sent up with the DeviceState in order for Assistant Server to be able to perform operations on them.
  • contextParams (type: String.t, default: nil) - Other context params to be sent to Assistant. This is a assistant.embedded.v1.ContextParams message in serialized binary proto format.
  • deviceTime (type: DateTime.t, default: nil) - A timestamp of the current device time when the request was made. This field is required if your device supports alarms or timers. This ensures that requests are fulfilled relative to the current device time and regardless of any clock skew between the client and the server.
  • deviceTimeZone (type: GoogleApi.ContentWarehouse.V1.Model.GoogleTypeTimeZone.t, default: nil) - The time zone where the device is currently located. This helps the Assistant answer time-related queries relative to the device's time zone. Generally speaking, mobile devices that support alarms or timers should supply device_time_zone. This field is required if your device supports alarms or timers and the device's location cannot reliably be determined. (See the comment above google.assistant.embedded.v1.DeviceLocation for a description of how the device's location is determined.) If the time zone cannot be determined, some queries for creating or modifying timers or alarms may fail with a generic error such as, "Sorry, I don't know how to help with that."
  • doNotDisturb (type: boolean(), default: nil) - Indicate whether do not disturb mode is turned on.
  • fitnessActivitiesState (type: GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantEmbeddedV1FitnessActivities.t, default: nil) - Information about on-device fitness activities. For devices that support fitness activities, all on-device fitness activities must be sent up with the DeviceState in order for Assistant Server to be able to perform operations on them.
  • installedApps (type: GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantAccessoryV1DeviceStateInstalledAppsState.t, default: nil) - Information about apps currently installed on device.
  • installedAppsZlib (type: String.t, default: nil) - This contains a zlib-compressed binary-encoded InstalledAppsState proto message.
  • timerState (type: GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantEmbeddedV1Timers.t, default: nil) - Optional Information about on-device timers. For devices that support timers, all on-device timers must be sent up with the DeviceState in order for Assistant Server to be able to perform operations on them.
  • unavailableSettings (type: list(String.t), default: nil) - This indicates which specific settings are currently unavailable for modification, despite being listed as a supported setting. Assistant can use this field to trigger unavailability messages, rather than claiming that a setting is entirely unsupported on device.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

Link to this type

t()

@type t() ::
  %GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantAccessoryV1DeviceState{
    alarmState:
      GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantEmbeddedV1Alarms.t()
      | nil,
    contextParams: String.t() | nil,
    deviceTime: DateTime.t() | nil,
    deviceTimeZone:
      GoogleApi.ContentWarehouse.V1.Model.GoogleTypeTimeZone.t() | nil,
    doNotDisturb: boolean() | nil,
    fitnessActivitiesState:
      GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantEmbeddedV1FitnessActivities.t()
      | nil,
    installedApps:
      GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantAccessoryV1DeviceStateInstalledAppsState.t()
      | nil,
    installedAppsZlib: String.t() | nil,
    timerState:
      GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantEmbeddedV1Timers.t()
      | nil,
    unavailableSettings: [String.t()] | nil
  }

Functions

Link to this function

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.