> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown. # IScheduledEmailDialogContextValue - Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md) - Kind: interface - Stability: beta - Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/presentation/automations/contexts/ScheduledEmailDialogContext.ts > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Sub-context for the scheduled-email create/edit dialog. The connector hydrates this from dashboard state and provides the CRUD callbacks; the dialog and its hooks read it instead of reaching into the dashboard store. That direction is enforced by the `no-model-imports-in-clean-scheduled-email` rule in `.dependency-cruiser.js`. **Signature:** ```typescript export interface IScheduledEmailDialogContextValue ``` ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [attributeFiltersModeMap](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvalueattributefiltersmodemap) | | Map<string, [DashboardAttributeFilterConfigMode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.dashboardattributefilterconfigmode/index.md)> | **_(BETA)_** Effective mode map for attribute filters (localIdentifier → mode). | | [commonDateFilterId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluecommondatefilterid) | | string | **_(BETA)_** _(Optional)_ Local identifier of the dashboard's common (dashboard-level) date filter, when the automation-available filters include one. | | [commonDateFilterMode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluecommondatefiltermode) | | [DashboardDateFilterConfigMode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.dashboarddatefilterconfigmode/index.md) | **_(BETA)_** Effective mode for the common (dashboard-level) date filter. | | [dashboardFilters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluedashboardfilters) | | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] | **_(BETA)_** _(Optional)_ Dashboard filters the export will use: the saved filters when editing, otherwise the currently applied dashboard filters with hidden filters resolved. | | [dashboardId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluedashboardid) | | string | **_(BETA)_** _(Optional)_ Id of the dashboard the scheduled export belongs to. | | [dashboardTitle](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluedashboardtitle) | | string | **_(BETA)_** Dashboard title; used as the subject placeholder. | | [dateFiltersModeMap](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluedatefiltersmodemap) | | Map<string, [DashboardDateFilterConfigMode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.dashboarddatefilterconfigmode/index.md)> | **_(BETA)_** Effective mode map for per-dataset date filters (localIdentifier → mode). | | [dateFormat](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluedateformat) | | string \| undefined | **_(BETA)_** Workspace date format (e.g. "MM/dd/yyyy"); from selectDateFormat. | | [exportParametersByTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvalueexportparametersbytab) | | Record<string, [IDashboardExportParameter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardexportparameter/index.md)[]> | **_(BETA)_** 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. | | [exportTemplates](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvalueexporttemplates) | | [IExportTemplate](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexporttemplate/index.md)[] | **_(BETA)_** Organization-level export templates fetched in the connector (replaces the useExportTemplates react hook read in the dialog). | | [hiddenFilters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluehiddenfilters) | | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] | **_(BETA)_** Raw dashboard hidden filters (selectDashboardHiddenFilters). Combined with edited filters via getAppliedDashboardFilters/getAppliedWidgetFilters inside the dialog, mirroring the alerting context. | | [insight?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvalueinsight) | | [IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md) | **_(BETA)_** _(Optional)_ Insight of [IScheduledEmailDialogContextValue.widget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluewidget); undefined when scheduling for a dashboard. | | [isCrossFiltering](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvalueiscrossfiltering) | | boolean | **_(BETA)_** Whether cross-filtering is active on the dashboard; from selectIsCrossFiltering. | | [isLoading](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvalueisloading) | | boolean | **_(BETA)_** True while the dialog's initial data (automations) is still loading. | | [notificationChannels](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluenotificationchannels) | | [INotificationChannelIdentifier](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelidentifier/index.md)[] \| [INotificationChannelMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelmetadataobject/index.md)[] | **_(BETA)_** Notification channels available as scheduled-export destinations. | | [scheduledExportToEdit?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluescheduledexporttoedit) | | [IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md) | **_(BETA)_** _(Optional)_ The scheduled export being edited; undefined when creating a new one. | | [widget?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluewidget) | | [IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md) | **_(BETA)_** _(Optional)_ Widget the scheduled export targets; undefined when scheduling an export for a dashboard rather than a widget. | | [widgetTitle?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluewidgettitle) | | string | **_(BETA)_** _(Optional)_ Title of [IScheduledEmailDialogContextValue.widget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluewidget); undefined when scheduling for a dashboard. | ## Methods | Method | Description | | --- | --- | | [createScheduledEmail(se)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluecreatescheduledemail) | **_(BETA)_** Creates a new scheduled export on the backend. | | [deleteScheduledEmail(se)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluedeletescheduledemail) | **_(BETA)_** Deletes the scheduled export from the backend. | | [saveScheduledEmail(se)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluesavescheduledemail) | **_(BETA)_** Saves changes to an existing scheduled export on the backend. | ## Property details ### IScheduledEmailDialogContextValue.attributeFiltersModeMap > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Effective mode map for attribute filters (localIdentifier → mode). **Signature:** ```typescript attributeFiltersModeMap: Map; ``` ### IScheduledEmailDialogContextValue.commonDateFilterId > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Local identifier of the dashboard's common (dashboard-level) date filter, when the automation-available filters include one. **Signature:** ```typescript commonDateFilterId?: string; ``` ### IScheduledEmailDialogContextValue.commonDateFilterMode > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Effective mode for the common (dashboard-level) date filter. **Signature:** ```typescript commonDateFilterMode: DashboardDateFilterConfigMode; ``` ### IScheduledEmailDialogContextValue.dashboardFilters > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Dashboard filters the export will use: the saved filters when editing, otherwise the currently applied dashboard filters with hidden filters resolved. **Signature:** ```typescript dashboardFilters?: FilterContextItem[]; ``` ### IScheduledEmailDialogContextValue.dashboardId > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Id of the dashboard the scheduled export belongs to. **Signature:** ```typescript dashboardId?: string; ``` ### IScheduledEmailDialogContextValue.dashboardTitle > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Dashboard title; used as the subject placeholder. **Signature:** ```typescript dashboardTitle: string; ``` ### IScheduledEmailDialogContextValue.dateFiltersModeMap > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Effective mode map for per-dataset date filters (localIdentifier → mode). **Signature:** ```typescript dateFiltersModeMap: Map; ``` ### IScheduledEmailDialogContextValue.dateFormat > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Workspace date format (e.g. "MM/dd/yyyy"); from selectDateFormat. **Signature:** ```typescript dateFormat: string | undefined; ``` ### IScheduledEmailDialogContextValue.exportParametersByTab > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > 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. **Signature:** ```typescript exportParametersByTab: Record; ``` ### IScheduledEmailDialogContextValue.exportTemplates > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Organization-level export templates fetched in the connector (replaces the useExportTemplates react hook read in the dialog). **Signature:** ```typescript exportTemplates: IExportTemplate[]; ``` ### IScheduledEmailDialogContextValue.hiddenFilters > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Raw dashboard hidden filters (selectDashboardHiddenFilters). Combined with edited filters via getAppliedDashboardFilters/getAppliedWidgetFilters inside the dialog, mirroring the alerting context. **Signature:** ```typescript hiddenFilters: FilterContextItem[]; ``` ### IScheduledEmailDialogContextValue.insight > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Insight of [IScheduledEmailDialogContextValue.widget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluewidget); undefined when scheduling for a dashboard. **Signature:** ```typescript insight?: IInsight; ``` ### IScheduledEmailDialogContextValue.isCrossFiltering > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Whether cross-filtering is active on the dashboard; from selectIsCrossFiltering. **Signature:** ```typescript isCrossFiltering: boolean; ``` ### IScheduledEmailDialogContextValue.isLoading > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > True while the dialog's initial data (automations) is still loading. **Signature:** ```typescript isLoading: boolean; ``` ### IScheduledEmailDialogContextValue.notificationChannels > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Notification channels available as scheduled-export destinations. **Signature:** ```typescript notificationChannels: INotificationChannelIdentifier[] | INotificationChannelMetadataObject[]; ``` ### IScheduledEmailDialogContextValue.scheduledExportToEdit > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > The scheduled export being edited; undefined when creating a new one. **Signature:** ```typescript scheduledExportToEdit?: IAutomationMetadataObject; ``` ### IScheduledEmailDialogContextValue.widget > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Widget the scheduled export targets; undefined when scheduling an export for a dashboard rather than a widget. **Signature:** ```typescript widget?: IWidget; ``` ### IScheduledEmailDialogContextValue.widgetTitle > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Title of [IScheduledEmailDialogContextValue.widget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogcontextvalue/index.md#ischeduledemaildialogcontextvaluewidget); undefined when scheduling for a dashboard. **Signature:** ```typescript widgetTitle?: string; ``` ## Method details ### IScheduledEmailDialogContextValue.createScheduledEmail() > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Creates a new scheduled export on the backend. **Signature:** ```typescript createScheduledEmail(se: IAutomationMetadataObjectDefinition): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | se | [IAutomationMetadataObjectDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectdefinition/index.md) | | **Returns:** Promise<[IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md)> ### IScheduledEmailDialogContextValue.deleteScheduledEmail() > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Deletes the scheduled export from the backend. **Signature:** ```typescript deleteScheduledEmail(se: IAutomationMetadataObject): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | se | [IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md) | | **Returns:** Promise<void> ### IScheduledEmailDialogContextValue.saveScheduledEmail() > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Saves changes to an existing scheduled export on the backend. **Signature:** ```typescript saveScheduledEmail(se: IAutomationMetadataObject): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | se | [IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md) | | **Returns:** Promise<[IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md)>