IScheduledEmailDialogProps

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

IScheduledEmailDialogProps 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.

Signature:

export interface IScheduledEmailDialogProps

Properties

PropertyModifiersTypeDescription
dashboardFilters?FilterContextItem[]

(ALPHA) (Optional) Dashboard filters to be used for scheduled email.

Note: - Provided filters exclude cross-filtering filters, as these are typically not desired in exported reports.

- If the current dashboard filters (excluding cross-filtering) match the saved dashboard filters, this will be undefined. In such cases, the scheduled export will use the most recent saved dashboard filters, guaranteeing that the export reflects the latest intended filter configuration and we don't want to save them.

- If we are editing an existing scheduled export, this will contain its filters, as changing saved filters is currently not allowed.

insight?IInsight

(ALPHA) (Optional) Insight to be used for scheduled email.

Note: this is available only when scheduling export for widget, not dashboard.

isLoading?boolean(ALPHA) (Optional) Is scheduled email dialog loading initial data, before it can be rendered?
isVisible?boolean(ALPHA) (Optional) Is scheduled e-mail dialog visible?
notificationChannelsINotificationChannelMetadataObject[](ALPHA) Notification channels in organization
onCancel?() => void(ALPHA) (Optional) Callback to be called, when user closes the scheduled email dialog.
onDeleteError?(error: GoodDataSdkError) => void(ALPHA) (Optional) Callback to be called, when schedule fails to delete.
onDeleteSuccess?() => void(ALPHA) (Optional) Callback to be called, when scheduled email is deleted.
onError?(error: GoodDataSdkError) => void(ALPHA) (Optional) Callback to be called, when error occurs.
onSave?(scheduledEmailDefinition: IAutomationMetadataObject) => void(ALPHA) (Optional) Callback to be called, when user save the existing scheduled email.
onSaveError?(error: GoodDataSdkError) => void(ALPHA) (Optional) Callback to be called, when error occurs.
onSaveSuccess?() => void(ALPHA) (Optional) Callback to be called, when scheduling finishes successfully.
onSubmit?(scheduledEmailDefinition: IAutomationMetadataObject | IAutomationMetadataObjectDefinition) => void(ALPHA) (Optional) Callback to be called, when user submits the scheduled email dialog.
onSuccess?(scheduledEmailDefinition: IAutomationMetadataObject) => void(ALPHA) (Optional) Callback to be called, when scheduling finishes successfully.
scheduledExportToEdit?IAutomationMetadataObject(ALPHA) (Optional) In case, we are not creating new schedule, but editing existing one, this is the active schedule to be edited.
usersIWorkspaceUser[](ALPHA) Users in workspace
widget?ExtendedDashboardWidget

(ALPHA) (Optional) Widget to be used for scheduled email.

Note: this is available only when scheduling export for widget, not dashboard.

widgetFilters?IFilter[]

(ALPHA) (Optional) Widget filters to be used for scheduled email.

Note: - Provided filters are a combination of insight and dashboard filters, following these rules: - Cross-filtering filters are excluded as they are typically not desired in the scheduled export. - The widget's ignored filters configuration is honored (ignored filters are not overridden by dashboard filters and remain as is). - If the resulting filters include all-time date filter, it is excluded as it has no effect on the scheduled export execution.

- If we are editing an existing scheduled export, this will contain its filters, as changing saved filters is currently not allowed.
← isBrokenAlertDateFilterInfo()IScheduledEmailManagementDialogProps →