IScheduledExportActionsContextValue
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The scheduled-export dialog’s mutators: the draft setter, the form change-handlers, the attachment handlers and the “Time zone” section handlers.
Changes rarely.
export interface IScheduledExportActionsContextValue
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
() => void | (BETA) Repairs a stale schedule timezone with the currently effective one. | ||
(settings: IExportDefinitionVisualizationObjectSettings) => void | (BETA) Sets the raw-CSV export settings (delimiter). | ||
(settings: IExportDefinitionVisualizationObjectSettings) => void | (BETA) Sets the CSV export settings (delimiter). | ||
(formats: DashboardAttachmentType[]) => void | (BETA) Replaces the dashboard export formats; new definitions inherit the current filters and timezone. | ||
(notificationChannelId: string) => void | (BETA) Selects the notification channel; recipients incompatible with it are dropped. | ||
(isShared: boolean) => void | (BETA) Switches between a shared and a per-recipient evaluation of the export. | ||
(value: string, isValid: boolean) => void | (BETA) Sets the e-mail message; | ||
(settings: IExportDefinitionVisualizationObjectSettings) => void | (BETA) Sets the tabular-PDF export settings (page size, orientation, export info). | ||
(recipients: IAutomationRecipient[]) => void | (BETA) Replaces the recipients with the complete updated array. | ||
(cronExpression: string, startDate: Date | null, isValid: boolean) => void | (BETA) Sets the cron expression and first run; | ||
(timezoneId: string | undefined) => void | (BETA) Picks the export-content timezone; undefined selects the Default option. | ||
(templateId: string | undefined, format: “PPTX” | “PDF_SLIDES” | “PDF”) => void | (BETA) Sets the slides template of one slides format; undefined restores the default template. | ||
(value: string | number, isValid: boolean) => void | (BETA) Sets the e-mail subject; | ||
(value: string) => void | (BETA) Sets the schedule title and re-validates its length. | ||
(formats: WidgetAttachmentType[]) => void | (BETA) Replaces the widget export formats; throws when the dialog has no widget. | ||
(settings: IExportDefinitionVisualizationObjectSettings) => void | (BETA) Sets the XLSX export settings (merge headers, export info). | ||
Dispatch<SetStateAction<IAutomationMetadataObjectDefinition>> | (BETA) Replaces the draft; the change-handlers below are the preferred, field-scoped writes. |
Property details
IScheduledExportActionsContextValue.applyCurrentScheduleTimezonepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Repairs a stale schedule timezone with the currently effective one.
applyCurrentScheduleTimezone: () => void;
IScheduledExportActionsContextValue.onCsvRawSettingsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the raw-CSV export settings (delimiter).
onCsvRawSettingsChange: (settings: IExportDefinitionVisualizationObjectSettings) => void;
IScheduledExportActionsContextValue.onCsvSettingsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the CSV export settings (delimiter).
onCsvSettingsChange: (settings: IExportDefinitionVisualizationObjectSettings) => void;
IScheduledExportActionsContextValue.onDashboardAttachmentsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Replaces the dashboard export formats; new definitions inherit the current filters and timezone.
onDashboardAttachmentsChange: (formats: DashboardAttachmentType[]) => void;
IScheduledExportActionsContextValue.onDestinationChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Selects the notification channel; recipients incompatible with it are dropped.
onDestinationChange: (notificationChannelId: string) => void;
IScheduledExportActionsContextValue.onEvaluationModeChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Switches between a shared and a per-recipient evaluation of the export.
onEvaluationModeChange: (isShared: boolean) => void;
IScheduledExportActionsContextValue.onMessageChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the e-mail message; isValid is the message field’s own verdict.
onMessageChange: (value: string, isValid: boolean) => void;
IScheduledExportActionsContextValue.onPdfSettingsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the tabular-PDF export settings (page size, orientation, export info).
onPdfSettingsChange: (settings: IExportDefinitionVisualizationObjectSettings) => void;
IScheduledExportActionsContextValue.onRecipientsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Replaces the recipients with the complete updated array.
onRecipientsChange: (recipients: IAutomationRecipient[]) => void;
IScheduledExportActionsContextValue.onRecurrenceChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the cron expression and first run; isValid is the recurrence form’s own verdict.
onRecurrenceChange: (cronExpression: string, startDate: Date | null, isValid: boolean) => void;
IScheduledExportActionsContextValue.onScheduleTimezoneChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Picks the export-content timezone; undefined selects the Default option.
onScheduleTimezoneChange: (timezoneId: string | undefined) => void;
IScheduledExportActionsContextValue.onSlidesTemplateIdChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the slides template of one slides format; undefined restores the default template.
onSlidesTemplateIdChange: (templateId: string | undefined, format: "PPTX" | "PDF_SLIDES" | "PDF") => void;
IScheduledExportActionsContextValue.onSubjectChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the e-mail subject; isValid is the subject field’s own verdict.
onSubjectChange: (value: string | number, isValid: boolean) => void;
IScheduledExportActionsContextValue.onTitleChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the schedule title and re-validates its length.
onTitleChange: (value: string) => void;
IScheduledExportActionsContextValue.onWidgetAttachmentsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Replaces the widget export formats; throws when the dialog has no widget.
onWidgetAttachmentsChange: (formats: WidgetAttachmentType[]) => void;
IScheduledExportActionsContextValue.onXlsxSettingsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the XLSX export settings (merge headers, export info).
onXlsxSettingsChange: (settings: IExportDefinitionVisualizationObjectSettings) => void;
IScheduledExportActionsContextValue.setEditedAutomationpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Replaces the draft; the change-handlers below are the preferred, field-scoped writes.
setEditedAutomation: Dispatch<SetStateAction<IAutomationMetadataObjectDefinition>>;