Skip to content

Enumeration: PrecannedDateRange

core.PrecannedDateRange

Special "live" date range values that can be used as the suggestedValue for a date array parameter.

Date array parameters are meant to represent date ranges. A date range can be a fixed range, e.g. April 1, 2020 - May 15, 2020, or it can be a "live" range, like "last 30 days".

At execution time, a date range will always be passed to a pack as an array of two specific dates, but for many use cases, it is necessary to provide a default value that is a "live" range rather than hardcoded one. For example, if your pack has a table that syncs recent emails, you might want to have a date range parameter that default to "last 7 days". Defaulting to a hardcoded date range would not be useful and requiring the user to always specify a date range may be inconvenient.

Enumeration Members

Everything

Everything = "everything"

Indicates a date range beginning in the very distant past (e.g. 1/1/1, aka 1 A.D.) and ending in the distant future (e.g. 12/31/3999). Exact dates are subject to change.

Defined in

api_types.ts:804


Last30Days

Last30Days = "last_30_days"

Defined in

api_types.ts:773


Last3Months

Last3Months = "last_3_months"

Defined in

api_types.ts:776


Last6Months

Last6Months = "last_6_months"

Defined in

api_types.ts:777


Last7Days

Last7Days = "last_7_days"

Defined in

api_types.ts:772


LastMonth

LastMonth = "last_month"

Defined in

api_types.ts:775


LastWeek

LastWeek = "last_week"

Defined in

api_types.ts:774


LastYear

LastYear = "last_year"

Defined in

api_types.ts:778


Next30Days

Next30Days = "next_30_days"

Defined in

api_types.ts:793


Next3Months

Next3Months = "next_3_months"

Defined in

api_types.ts:796


Next6Months

Next6Months = "next_6_months"

Defined in

api_types.ts:797


Next7Days

Next7Days = "next_7_days"

Defined in

api_types.ts:792


NextMonth

NextMonth = "next_month"

Defined in

api_types.ts:795


NextWeek

NextWeek = "next_week"

Defined in

api_types.ts:794


NextYear

NextYear = "next_year"

Defined in

api_types.ts:798


ThisMonth

ThisMonth = "this_month"

Defined in

api_types.ts:784


ThisMonthStart

ThisMonthStart = "this_month_start"

Defined in

api_types.ts:785


ThisWeek

ThisWeek = "this_week"

Defined in

api_types.ts:782


ThisWeekStart

ThisWeekStart = "this_week_start"

Defined in

api_types.ts:783


ThisYear

ThisYear = "this_year"

Defined in

api_types.ts:788


ThisYearStart

ThisYearStart = "this_year_start"

Defined in

api_types.ts:786


Today

Today = "today"

Defined in

api_types.ts:781


Tomorrow

Tomorrow = "tomorrow"

Defined in

api_types.ts:791


YearToDate

YearToDate = "year_to_date"

Defined in

api_types.ts:787


Yesterday

Yesterday = "yesterday"

Defined in

api_types.ts:771