IAlertingDialogProps

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

IAlertingDialogProps 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 IAlertingDialogProps

Properties

PropertyModifiersTypeDescription
alertToEdit?IAutomationMetadataObject(ALPHA) (Optional) In case, we are not creating new alert, but editing existing one, this is the active alert to be edited.
dashboardFilters?FilterContextItem[]

(ALPHA) (Optional) Dashboard filters to be used for alert.

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 alert will use the most recent saved dashboard filters, guaranteeing that the alert reflects the latest intended filter configuration and we don't want to save them.

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

insight?IInsight

(ALPHA) (Optional) Insight to be used for alert.

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

isLoading?boolean(ALPHA) (Optional) Is alert dialog loading initial data, before it can be rendered?
notificationChannelsINotificationChannelMetadataObject[](ALPHA) Notification channels in organization
onCancel?() => void(ALPHA) (Optional) Callback to be called, when user closes the alert dialog.
onDeleteError?(error: GoodDataSdkError) => void(ALPHA) (Optional) Callback to be called, when alert fails to delete.
onDeleteSuccess?(alert: IAutomationMetadataObject) => void(ALPHA) (Optional) Callback to be called, when alert is deleted.
onError?(error: GoodDataSdkError) => void(ALPHA) (Optional) Callback to be called, when error occurs.
onSaveError?(error: GoodDataSdkError) => void(ALPHA) (Optional) Callback to be called, when error occurs.
onSaveSuccess?(alert: IAutomationMetadataObject) => void(ALPHA) (Optional) Callback to be called, when alerting finishes successfully.
onSuccess?(alertDefinition: IAutomationMetadataObject) => void(ALPHA) (Optional) Callback to be called, when alerting finishes successfully.
usersIWorkspaceUser[](ALPHA) Users in workspace
usersError?GoodDataSdkError(ALPHA) (Optional) Error occurred while loading users
widget?ExtendedDashboardWidget

(ALPHA) (Optional) Widget to be used for alert.

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

widgetFilters?IFilter[]

(ALPHA) (Optional) Widget filters to be used for alert.

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 alert. - 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 alert execution.

- If we are editing an existing alert, this will contain its filters, as changing saved filters is currently not allowed.
← IAlertingDialogOldPropsIAlertingManagementDialogOldProps →