IAlertingDialogContextValue

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

IAlertingDialogContextValue 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 alerting 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-alerting rule in .dependency-cruiser.js.

Signature:

export interface IAlertingDialogContextValue 

Properties

Property	Modifiers	Type	Description
alertToEdit?		IAutomationMetadataObject	(ALPHA) (Optional) The alert being edited; undefined when creating a new one.
commonDateFilterId?		string	(ALPHA) (Optional)
dashboardEvaluationFrequency?		string	(ALPHA) (Optional)
dashboardFilters		FilterContextItem[]	(ALPHA)
dashboardId?		string	(ALPHA) (Optional)
executionResultByRef		(ref: ObjRef | undefined) => { executionResult?: IExecutionResult; } | undefined	(ALPHA)
hiddenFilters		FilterContextItem[]	(ALPHA)
insight?		IInsight	(ALPHA) (Optional)
isLoading		boolean	(ALPHA) True while the dialog's initial data (automations, workspace users) is still loading.
mode		"create" | "edit"	(ALPHA)
notificationChannels		INotificationChannelIdentifier[] | INotificationChannelMetadataObject[]	(ALPHA) Notification channels available as alert destinations.
parameterValues		IInsightParameterValue[]	(ALPHA) Effective widget parameter values for the dialog's widget (replaces direct selectEffectiveParameterValuesForWidget read)
users		IWorkspaceUser[]	(ALPHA) Workspace users available as alert 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
createAlert(alert)	(ALPHA)
deleteAlert(alert)	(ALPHA)
saveAlert(alert)	(ALPHA)