useDashboardAlerts()

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

useDashboardAlerts() function

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 alert dialogs.

Signature:

useDashboardAlerts: () => {
    alertToEdit: import("@gooddata/sdk-model").IAutomationMetadataObject | undefined;
    isInitialized: boolean;
    notificationChannels: import("@gooddata/sdk-model").INotificationChannelMetadataObject[] | import("@gooddata/sdk-model").INotificationChannelIdentifier[];
    automations: import("@gooddata/sdk-model").IAutomationMetadataObject[];
    automationsCount: number;
    numberOfAvailableDestinations: number;
    widget: import("@gooddata/sdk-model").IWidget | import("../../index.js").ICustomWidget | undefined;
    insight: import("@gooddata/sdk-model").IInsight | undefined;
    automationsLoading: boolean;
    automationsError: import("@gooddata/sdk-ui").GoodDataSdkError | undefined;
    isAlertingVisible: boolean;
    isAlertDialogOpen: boolean;
    defaultOnAlerting: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    onAlertingOpen: (widget?: import("@gooddata/sdk-model").IWidget, alert?: import("@gooddata/sdk-model").IAutomationMetadataObject) => void;
    onAlertingCancel: () => void;
    onAlertingCreateError: () => void;
    onAlertingCreateSuccess: (alert: import("@gooddata/sdk-model").IAutomationMetadataObject) => void;
    onAlertingSaveError: () => void;
    onAlertingSaveSuccess: () => void;
    isAlertManagementVisible: boolean;
    isAlertManagementDialogOpen: boolean;
    defaultOnAlertingManagement: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    onAlertingManagementOpen: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    onAlertingManagementClose: () => void;
    onAlertingManagementAdd: (targetWidget?: import("@gooddata/sdk-model").IWidget) => void;
    onAlertingManagementDeleteError: () => void;
    onAlertingManagementDeleteSuccess: () => void;
    onAlertingManagementEdit: (alert: import("@gooddata/sdk-model").IAutomationMetadataObject, widget?: import("@gooddata/sdk-model").IWidget) => void;
    onAlertingManagementLoadingError: () => void;
    onAlertingManagementPauseSuccess: (_alert: import("@gooddata/sdk-model").IAutomationMetadataObject, pause: boolean) => void;
    onAlertingManagementPauseError: (_error: import("@gooddata/sdk-ui").GoodDataSdkError, pause: boolean) => void;
}

Returns:

{ alertToEdit: import("@gooddata/sdk-model").IAutomationMetadataObject | undefined; isInitialized: boolean; notificationChannels: import("@gooddata/sdk-model").INotificationChannelMetadataObject[] | import("@gooddata/sdk-model").INotificationChannelIdentifier[]; automations: import("@gooddata/sdk-model").IAutomationMetadataObject[]; automationsCount: number; numberOfAvailableDestinations: number; widget: import("@gooddata/sdk-model").IWidget | import("../../index.js").ICustomWidget | undefined; insight: import("@gooddata/sdk-model").IInsight | undefined; automationsLoading: boolean; automationsError: import("@gooddata/sdk-ui").GoodDataSdkError | undefined; isAlertingVisible: boolean; isAlertDialogOpen: boolean; defaultOnAlerting: (widget?: import("@gooddata/sdk-model").IWidget) => void; onAlertingOpen: (widget?: import("@gooddata/sdk-model").IWidget, alert?: import("@gooddata/sdk-model").IAutomationMetadataObject) => void; onAlertingCancel: () => void; onAlertingCreateError: () => void; onAlertingCreateSuccess: (alert: import("@gooddata/sdk-model").IAutomationMetadataObject) => void; onAlertingSaveError: () => void; onAlertingSaveSuccess: () => void; isAlertManagementVisible: boolean; isAlertManagementDialogOpen: boolean; defaultOnAlertingManagement: (widget?: import("@gooddata/sdk-model").IWidget) => void; onAlertingManagementOpen: (widget?: import("@gooddata/sdk-model").IWidget) => void; onAlertingManagementClose: () => void; onAlertingManagementAdd: (targetWidget?: import("@gooddata/sdk-model").IWidget) => void; onAlertingManagementDeleteError: () => void; onAlertingManagementDeleteSuccess: () => void; onAlertingManagementEdit: (alert: import("@gooddata/sdk-model").IAutomationMetadataObject, widget?: import("@gooddata/sdk-model").IWidget) => void; onAlertingManagementLoadingError: () => void; onAlertingManagementPauseSuccess: (_alert: import("@gooddata/sdk-model").IAutomationMetadataObject, pause: boolean) => void; onAlertingManagementPauseError: (_error: import("@gooddata/sdk-ui").GoodDataSdkError, pause: boolean) => void; }