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

Property	Modifiers	Type	Description
alertToEdit?		IAutomationMetadataObject	(ALPHA) (Optional) In case, we are not creating new alert, but editing existing one, this is the active alert to be edited.
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?
notificationChannels		INotificationChannelMetadataObject[]	(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.
users		IWorkspaceUser[]	(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.