IAlertingManagementDialogContextValue

IAlertingManagementDialogContextValue.alertingDialogReturnFocusTopropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Element ID to return focus to when the alerting dialog closes; from selectAlertingDialogReturnFocusTo, read via useAlertingDialogAccessibility.

alertingDialogReturnFocusTo?: string;

IAlertingManagementDialogContextValue.automationspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Alerts visible in the management dialog, scoped to the current dashboard context.

automations: IAutomationMetadataObject[];

IAlertingManagementDialogContextValue.automationsInvalidationIdpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Cache-bust counter for the automation list: reset to 0 when a management dialog opens, incremented on invalidation. 0 means nothing has been invalidated since the dialog opened; consumers reload when the value changes and is not 0.

automationsInvalidationId?: number;

IAlertingManagementDialogContextValue.canManageWorkspacepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Whether the current user may manage the workspace; from selectCanManageWorkspace. Combined with alert ownership to gate edit/delete.

canManageWorkspace: boolean;

IAlertingManagementDialogContextValue.currentUserpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

The logged-in user; from selectCurrentUser. Used to decide whether the user may edit/delete an alert they didn’t create.

currentUser?: IUser;

IAlertingManagementDialogContextValue.dashboardIdpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Id of the dashboard the management dialog is rendered on. Used to preselect the dashboard filter in the enhanced automations list.

dashboardId?: string;

IAlertingManagementDialogContextValue.dashboardTitlepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Title of the dashboard the management dialog is rendered on. Used as the label of the preselected dashboard filter in the enhanced automations list.

dashboardTitle?: string;

IAlertingManagementDialogContextValue.enableAccessibilityModepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Whether accessibility mode is active (for aria/keyboard focus management).

enableAccessibilityMode: boolean;

IAlertingManagementDialogContextValue.getInsightByWidgetRefpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Looks up the insight of an insight widget by the widget’s ref; undefined for a non-insight widget.

getInsightByWidgetRef: (ref: ObjRef | undefined) => IInsight | undefined;

IAlertingManagementDialogContextValue.getWidgetByRefpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Looks up a dashboard widget (KPI, insight, rich text, or visualization-switcher) by ref, filtering out non-widget layout containers; bridges identifier↔URI ref mismatches the same way as selectWidgetByRef.

getWidgetByRef: (ref: ObjRef | undefined) => IWidget | undefined;

IAlertingManagementDialogContextValue.isAlertDialogOpenpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Whether the alert create/edit dialog is currently open (from store UI slice). Used by the management dialog’s focus-return logic (refocus when the edit dialog closes).

isAlertDialogOpen: boolean;

IAlertingManagementDialogContextValue.isEmbeddedpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Whether the dashboard is rendered in an embedded context.

isEmbedded: boolean;

IAlertingManagementDialogContextValue.isLoadingpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

True while the automation list is still loading.

The automations load only — deliberately narrower than the scheduled-email management context’s flag, which also folds in a widget-filters load that has no bearing on a management list.

isLoading: boolean;

IAlertingManagementDialogContextValue.managementDialogContextpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Widget the management dialog is scoped to, when opened for a single widget rather than the whole dashboard; from selectIsAlertingManagementDialogContext.

managementDialogContext: {
        widgetRef?: ObjRef;
    };

IAlertingManagementDialogContextValue.pauseAlert()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Persists the given alert via the alerts save command; resolves with the saved alert, rejects with the command’s error.

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

Parameters

Returns

Promise<IAutomationMetadataObject>

IAlertingManagementDialogContextValue.resumeAlert()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Persists the given alert via the alerts save command; resolves with the saved alert, rejects with the command’s error. Functionally identical to IAlertingManagementDialogContextValue.pauseAlert() — distinguished only by name for call-site clarity.

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

Parameters

Returns

Promise<IAutomationMetadataObject>