IScheduledEmailDialogContextValue

IScheduledEmailDialogContextValue.attributeFiltersModeMappropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Effective mode map for attribute filters (localIdentifier → mode).

attributeFiltersModeMap: Map<string, DashboardAttributeFilterConfigMode>;

IScheduledEmailDialogContextValue.commonDateFilterIdpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Local identifier of the dashboard’s common (dashboard-level) date filter, when the automation-available filters include one.

commonDateFilterId?: string;

IScheduledEmailDialogContextValue.commonDateFilterModepropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Effective mode for the common (dashboard-level) date filter.

commonDateFilterMode: DashboardDateFilterConfigMode;

IScheduledEmailDialogContextValue.dashboardFilterspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Dashboard filters the export will use: the saved filters when editing, otherwise the currently applied dashboard filters with hidden filters resolved.

dashboardFilters?: FilterContextItem[];

IScheduledEmailDialogContextValue.dashboardIdpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Id of the dashboard the scheduled export belongs to.

dashboardId?: string;

IScheduledEmailDialogContextValue.dashboardTitlepropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Dashboard title; used as the subject placeholder.

dashboardTitle: string;

IScheduledEmailDialogContextValue.dateFiltersModeMappropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Effective mode map for per-dataset date filters (localIdentifier → mode).

dateFiltersModeMap: Map<string, DashboardDateFilterConfigMode>;

IScheduledEmailDialogContextValue.dateFormatpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Workspace date format (e.g. “MM/dd/yyyy”); from selectDateFormat.

dateFormat: string | undefined;

IScheduledEmailDialogContextValue.exportParametersByTabpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Effective export parameter overrides keyed by tab, scoped to the dialog’s widget when present. Hydrated by the connector, so the dialog tree reads no store selector for them.

exportParametersByTab: Record<string, IDashboardExportParameter[]>;

IScheduledEmailDialogContextValue.exportTemplatespropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Organization-level export templates fetched in the connector (replaces the useExportTemplates react hook read in the dialog).

exportTemplates: IExportTemplate[];

IScheduledEmailDialogContextValue.hiddenFilterspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Raw dashboard hidden filters (selectDashboardHiddenFilters). Combined with edited filters via getAppliedDashboardFilters/getAppliedWidgetFilters inside the dialog, mirroring the alerting context.

hiddenFilters: FilterContextItem[];

IScheduledEmailDialogContextValue.insightpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Insight of IScheduledEmailDialogContextValue.widget; undefined when scheduling for a dashboard.

insight?: IInsight;

IScheduledEmailDialogContextValue.isCrossFilteringpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Whether cross-filtering is active on the dashboard; from selectIsCrossFiltering.

isCrossFiltering: boolean;

IScheduledEmailDialogContextValue.isLoadingpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

True while the dialog’s initial data (automations) is still loading.

isLoading: boolean;

IScheduledEmailDialogContextValue.notificationChannelspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Notification channels available as scheduled-export destinations.

notificationChannels: INotificationChannelIdentifier[] | INotificationChannelMetadataObject[];

IScheduledEmailDialogContextValue.scheduledExportToEditpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

The scheduled export being edited; undefined when creating a new one.

scheduledExportToEdit?: IAutomationMetadataObject;

IScheduledEmailDialogContextValue.widgetpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Widget the scheduled export targets; undefined when scheduling an export for a dashboard rather than a widget.

widget?: IWidget;

IScheduledEmailDialogContextValue.widgetTitlepropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Title of IScheduledEmailDialogContextValue.widget; undefined when scheduling for a dashboard.

widgetTitle?: string;

IScheduledEmailDialogContextValue.createScheduledEmail()methodBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Creates a new scheduled export on the backend.

createScheduledEmail(se: IAutomationMetadataObjectDefinition): Promise<IAutomationMetadataObject>;

Parameters

Returns

Promise<IAutomationMetadataObject>

IScheduledEmailDialogContextValue.deleteScheduledEmail()methodBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Deletes the scheduled export from the backend.

deleteScheduledEmail(se: IAutomationMetadataObject): Promise<void>;

Parameters

Returns

Promise<void>

IScheduledEmailDialogContextValue.saveScheduledEmail()methodBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Saves changes to an existing scheduled export on the backend.

saveScheduledEmail(se: IAutomationMetadataObject): Promise<IAutomationMetadataObject>;

Parameters

Returns

Promise<IAutomationMetadataObject>