View Source GoogleApi.ContentWarehouse.V1.Model.AssistantApiRecurrence (google_api_content_warehouse v0.4.0)

Date-based recurrences specify repeating events. Conceptually, a recurrence is a (possibly unbounded) sequence of dates on which an event falls, described by a list of constraints. A date is in a recurrence if and only if it satisfies all of the constraints. Note that devices may support some constraints, but not all.

Attributes

  • begin (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate.t, default: nil) - The first day of the recurrence. If begin is not set, then the reminder will start infinitely in the past.
  • blacklistedRanges (type: list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTimeRange.t), default: nil) - A list of blacklisted dates to skip the alarm on.
  • dayOfMonth (type: list(integer()), default: nil) - Specifies the date in a month. For example, if day_of_month is 15, then it represent the 15th day of the specified month.
  • dayOfWeek (type: list(integer()), default: nil) - Specifies a weekly or daily recurrence. Constraint: The date falls on one of these days of the week, in 0...6 (Sunday...Saturday).
  • end (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate.t, default: nil) - The last day of the recurrence.
  • every (type: integer(), default: nil) - Multiplier on the frequency of the recurrence. Use this to specify patterns that recur every X days, months, years, etc. Example: [remind me to call mom every 2nd week]. Default is 1 (every day, every month, every year).
  • monthOfYear (type: list(integer()), default: nil) - Specifies the month in a year. Constrain: the month falls on one of these months, in 1, 2, ... 12 (January...December).
  • numOccurrences (type: integer(), default: nil) - The number of occurrences after which the recurrence should end.
  • weekOfMonth (type: list(integer()), default: nil) - Specifies the index of week in a month. For example, the second Tuesday every month, in this case, week_of_month should be 2.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiRecurrence{
  begin: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate.t() | nil,
  blacklistedRanges:
    [GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTimeRange.t()] | nil,
  dayOfMonth: [integer()] | nil,
  dayOfWeek: [integer()] | nil,
  end: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate.t() | nil,
  every: integer() | nil,
  monthOfYear: [integer()] | nil,
  numOccurrences: integer() | nil,
  weekOfMonth: [integer()] | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.