IScheduledEmailDialogContextValue

Home > @gooddata/sdk-ui-dashboard > IScheduledEmailDialogContextValue

IScheduledEmailDialogContextValue interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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:

export interface IScheduledEmailDialogContextValue 

Properties

Property	Modifiers	Type	Description
attributeFiltersModeMap		Map<string, DashboardAttributeFilterConfigMode>	(ALPHA) Effective mode map for attribute filters (localIdentifier → mode).
commonDateFilterId?		string	(ALPHA) (Optional)
commonDateFilterMode		DashboardDateFilterConfigMode	(ALPHA) Effective mode for the common (dashboard-level) date filter.
dashboardFilters?		FilterContextItem[]	(ALPHA) (Optional) Dashboard filters the export will use: the saved filters when editing, otherwise the currently applied dashboard filters with hidden filters resolved.
dashboardId?		string	(ALPHA) (Optional)
dashboardTitle		string	(ALPHA)
dateFiltersModeMap		Map<string, DashboardDateFilterConfigMode>	(ALPHA) Effective mode map for per-dataset date filters (localIdentifier → mode).
dateFormat		string | undefined	(ALPHA) Workspace date format (e.g. "MM/dd/yyyy"); from selectDateFormat.
exportParametersByTab		Record<string, IDashboardExportParameter[]>	(ALPHA) Effective export parameter overrides keyed by tab, scoped to the dialog's widget when present. Replaces the direct selectExportEffectiveParameters read in useEditScheduledEmail.
exportTemplates		IExportTemplate[]	(ALPHA) Organization-level export templates fetched in the connector (replaces the useExportTemplates react hook read in the dialog).
hasMultipleTabs		boolean	(ALPHA) Whether the dashboard has more than one tab; derived from selectTabs.
hiddenFilters		FilterContextItem[]	(ALPHA) Raw dashboard hidden filters (selectDashboardHiddenFilters). Combined with edited filters via getAppliedDashboardFilters/getAppliedWidgetFilters inside the dialog, mirroring the alerting context.
insight?		IInsight	(ALPHA) (Optional)
isCrossFiltering		boolean	(ALPHA) Whether cross-filtering is active on the dashboard; from selectIsCrossFiltering.
isLoading		boolean	(ALPHA) True while the dialog's initial data (automations, workspace users) is still loading.
notificationChannels		INotificationChannelIdentifier[] | INotificationChannelMetadataObject[]	(ALPHA) Notification channels available as scheduled-export destinations.
scheduledExportToEdit?		IAutomationMetadataObject	(ALPHA) (Optional) The scheduled export being edited; undefined when creating a new one.
users		IWorkspaceUser[]	(ALPHA) Workspace users available as scheduled-export recipients. Loaded only while the create/edit dialog is mounted, so opening the management dialog alone does not trigger the load.
usersError?		GoodDataSdkError	(ALPHA) (Optional) Error from loading workspace users, if any.
widget?		IWidget	(ALPHA) (Optional)
widgetLocalIdToTabIdMap		Record<string, string>	(ALPHA)
widgetTitle?		string	(ALPHA) (Optional)

Methods

Method	Description
createScheduledEmail(se)	(ALPHA)
deleteScheduledEmail(se)	(ALPHA)
saveScheduledEmail(se)	(ALPHA)