useDashboardAlerts

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

useDashboardAlerts variable

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.

Hook that handles alerts dialog

Signature:

useDashboardAlerts: () => {
    isInitialized: boolean;
    automations: IAutomationMetadataObject[];
    alertingToEdit: {
        alert: IAutomationMetadataObject;
        widget: IInsightWidget | undefined;
        anchor: HTMLElement | null;
    } | null;
    alertingLoadError: GoodDataSdkError | undefined;
    isAlertingLoading: boolean;
    isAlertsManagementVisible: boolean;
    isAlertingDialogOpen: boolean;
    isAlertingManagementDialogOpen: boolean;
    defaultOnAlerting: () => void;
    defaultOnAlertsManagement: () => void;
    onAlertingManagementEdit: (alert: IAutomationMetadataObject, widget: IInsightWidget | undefined, anchor: HTMLElement | null, onClosed: () => void) => void;
    onAlertingManagementClose: () => void;
    onAlertingManagementDeleteSuccess: () => void;
    onAlertingManagementDeleteError: () => void;
    onAlertingManagementLoadingError: () => void;
    onAlertingManagementPauseSuccess: (_alert: IAutomationMetadataObject, pause: boolean) => void;
    onAlertingManagementPauseError: (_err: GoodDataSdkError, pause: boolean) => void;
    onAlertingCancel: () => void;
    onAlertingUpdate: (_alert: IAutomationMetadataObject) => void;
}