IScheduledEmailDialogRecurrenceProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Props of the scheduled-export dialog’s recurrence field.
export interface IScheduledEmailDialogRecurrenceProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (BETA) Whether the hourly recurrence option is offered. | ||
boolean | (BETA) Closes the recurrence dropdowns when the dialog body scrolls. | ||
string | (BETA) (Optional) Human-readable description of the cron expression, when the draft carries one. | ||
string | (BETA) The draft’s cron expression. | ||
string | (BETA) Date format used by the first-run date picker. | ||
boolean | (BETA) Hides GoodData-specific copy when white-labeled. | ||
string | (BETA) Locale of the recurrence editor. | ||
(cronExpression: string, startDate: Date | null, isValid: boolean) => void | (BETA) Sets the cron expression and first run; | ||
(event: KeyboardEvent) => void | (BETA) Key-down handler; the dialog submits on Enter through it. | ||
Date | (BETA) First-run date the cron editor is anchored to. | ||
string | (BETA) Display-only timezone label shown in the occurrence description. | ||
(BETA) First day of the week in the date picker. |
Property details
IScheduledEmailDialogRecurrenceProps.allowHourlyRecurrencepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Whether the hourly recurrence option is offered.
allowHourlyRecurrence: boolean;
IScheduledEmailDialogRecurrenceProps.closeDropdownsOnParentScrollpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Closes the recurrence dropdowns when the dialog body scrolls.
closeDropdownsOnParentScroll: boolean;
IScheduledEmailDialogRecurrenceProps.cronDescriptionpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Human-readable description of the cron expression, when the draft carries one.
cronDescription?: string;
IScheduledEmailDialogRecurrenceProps.cronExpressionpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The draft’s cron expression.
cronExpression: string;
IScheduledEmailDialogRecurrenceProps.dateFormatpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Date format used by the first-run date picker.
dateFormat: string;
IScheduledEmailDialogRecurrenceProps.isWhiteLabeledpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Hides GoodData-specific copy when white-labeled.
isWhiteLabeled: boolean;
IScheduledEmailDialogRecurrenceProps.localepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Locale of the recurrence editor.
locale: string;
IScheduledEmailDialogRecurrenceProps.onChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets the cron expression and first run; isValid is the recurrence form’s own verdict.
onChange: (cronExpression: string, startDate: Date | null, isValid: boolean) => void;
IScheduledEmailDialogRecurrenceProps.onKeyDownSubmitpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Key-down handler; the dialog submits on Enter through it.
onKeyDownSubmit: (event: KeyboardEvent) => void;
IScheduledEmailDialogRecurrenceProps.startDatepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
First-run date the cron editor is anchored to.
startDate: Date;
IScheduledEmailDialogRecurrenceProps.timezonepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Display-only timezone label shown in the occurrence description.
timezone: string;
IScheduledEmailDialogRecurrenceProps.weekStartpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
First day of the week in the date picker.
weekStart: WeekStart;