AssistantApiRecurrence

Posted on by Darth Emmett

GoogleApi.ContentWarehouse.V1.Model.AssistantApiRecurrence

Table of Contents ▼

Jump to a specific part of the page:

Description

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 List

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

View Attributes

Attributes

  1. begin (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate, default: nil)
    - The first day of the recurrence. If begin is not set, then the reminder will start infinitely in the past.
  2. blacklistedRanges (type: list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTimeRange), default: nil)
    - A list of blacklisted dates to skip the alarm on.
  3. 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.
  4. 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).
  5. end (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate, default: nil)
    - The last day of the recurrence.
  6. 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).
  7. 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).
  8. numOccurrences (type: integer(), default: nil)
    - The number of occurrences after which the recurrence should end.
  9. 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.

Type

@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
}

Function

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

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