GoogleAssistantEmbeddedV1Alarm

Description

Alarms are clocks that ring at a specified time on one or more days. The client schedules a time to ring based on the date/time pattern. When it rings, it may be rescheduled off the original time by snoozing or it may be replaced by the next occurrence.

Attributes List

This module has the following attributes (case-insensitive ascending order):

Attributes

1. alarmId (type: String.t, default: nil)
   - A string key used as an identifier to this alarm. This key needs to be unique amongst all alarms on the device. The client can choose a mechanism of its choice to ensure this. If the server suggests an alarm_id, the client can either use the suggestion or create a new unique alarm_id of its choosing.
2. alarmSource (type: String.t, default: nil)
   - The entity that created this alarm. Note this may be different from the device that reported this alarm. In particular, this field is meant for remote alarms which have been synced to the current device by the Clock app. Synced alarms exist in each device's Clock app and can be managed by either device; this field indicates their origin.
3. datePattern (type: GoogleApi.ContentWarehouse.V1.Model.GoogleTypeDate, default: nil)
   - For single alarms: the one date the alarm should next be scheduled for.
4. label (type: String.t, default: nil)
   - A user-provided name for this alarm.
5. recurrencePattern (type: GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantEmbeddedV1AlarmRecurrence, default: nil)
   - For recurring alarms: a description of the dates when the alarm should recur.
6. scheduledTime (type: DateTime.t, default: nil)
   - When SCHEDULED or SNOOZED, the absolute time the alarm will fire next. When SNOOZED, this time includes the additional time added by snoozing the alarm. When FIRING, the absolute time the alarm had been scheduled to fire. When DISABLED, this field is undefined and should be ignored.
7. status (type: String.t, default: nil)
   - Describes the part of the lifecycle that an alarm is in.
8. timePattern (type: GoogleApi.ContentWarehouse.V1.Model.GoogleTypeTimeOfDay, default: nil)
   - The time of day the alarm should be scheduled for. This value does not change when an alarm enters the SNOOZED state; instead the scheduled_time field should be adjusted to the new alarm time.

Type

Function

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantEmbeddedV1Alarm

• ‹ GoogleAssistantAccessoryV1ScreenOutConfigDimensions
• GoogleAssistantEmbeddedV1AlarmRecurrence ›

Possibly related Links