IAlertingDialogContextValue

IAlertingDialogContextValue.alertToEditpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

The alert being edited; undefined when creating a new one.

alertToEdit?: IAutomationMetadataObject;

IAlertingDialogContextValue.commonDateFilterIdpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Local identifier of the dashboard’s common (dashboard-level) date filter, when the automation-available filters include one.

commonDateFilterId?: string;

IAlertingDialogContextValue.dashboardEvaluationFrequencypropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

The dashboard’s configured evaluation frequency (cron expression); seeds the new alert’s trigger interval when set.

dashboardEvaluationFrequency?: string;

IAlertingDialogContextValue.dashboardFilterspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

The dashboard’s applied filters available to the alert — cross-filtering, hidden, and empty filters excluded.

dashboardFilters: FilterContextItem[];

IAlertingDialogContextValue.dashboardIdpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Id of the dashboard the alert belongs to.

dashboardId?: string;

IAlertingDialogContextValue.dashboardParameterspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Effective dashboard parameters for the dialog’s widget — the owning tab’s parameters with any runtime override folded in (replaces the direct selectEffectiveDashboardParametersForWidget read in useAutomationAlertParameters).

dashboardParameters: IDashboardParameter[];

IAlertingDialogContextValue.executionResultByRefpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Looks up a widget’s execution result by ref; used to resolve attribute values for the condition’s “for” field.

executionResultByRef: (ref: ObjRef | undefined) => {
        executionResult?: IExecutionResult;
    } | undefined;

IAlertingDialogContextValue.hiddenFilterspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Raw dashboard hidden filters (selectDashboardHiddenFilters); combined with the edited filters via getAppliedWidgetFilters inside the dialog.

hiddenFilters: FilterContextItem[];

IAlertingDialogContextValue.insightpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Insight of IAlertingDialogContextValue.widget; undefined when alerting for a dashboard.

insight?: IInsight;

IAlertingDialogContextValue.isLoadingpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

True while the dialog’s initial data (automations) is still loading.

isLoading: boolean;

IAlertingDialogContextValue.modepropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Whether the dialog creates a new alert or edits an existing one.

mode: "create" | "edit";

IAlertingDialogContextValue.notificationChannelspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Notification channels available as alert destinations.

notificationChannels: INotificationChannelIdentifier[] | INotificationChannelMetadataObject[];

IAlertingDialogContextValue.parameterValuespropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Effective widget parameter values for the dialog’s widget (replaces direct selectEffectiveParameterValuesForWidget read)

parameterValues: IInsightParameterValue[];

IAlertingDialogContextValue.widgetpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Widget the alert targets; undefined when alerting for a dashboard rather than a widget.

widget?: IWidget;

IAlertingDialogContextValue.widgetTitlepropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Title of IAlertingDialogContextValue.widget; undefined when alerting for a dashboard.

widgetTitle?: string;

IAlertingDialogContextValue.createAlert()methodBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Creates a new alert on the backend.

createAlert(alert: IAutomationMetadataObjectDefinition): Promise<IAutomationMetadataObject>;

Parameters

Returns

Promise<IAutomationMetadataObject>

IAlertingDialogContextValue.deleteAlert()methodBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Deletes the alert from the backend.

deleteAlert(alert: IAutomationMetadataObject): Promise<void>;

Parameters

Returns

Promise<void>

IAlertingDialogContextValue.saveAlert()methodBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Saves changes to an existing alert on the backend.

saveAlert(alert: IAutomationMetadataObject): Promise<IAutomationMetadataObject>;

Parameters

Returns

Promise<IAutomationMetadataObject>