useDashboardAlerts()

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

Hook that handles alert dialogs.

useDashboardAlerts: () => {
    alertToEdit: import("@gooddata/sdk-model").IAutomationMetadataObject | undefined;
    isInitialized: boolean;
    notificationChannels: import("@gooddata/sdk-model").INotificationChannelIdentifier[] | import("@gooddata/sdk-model").INotificationChannelMetadataObject[];
    automations: import("@gooddata/sdk-model").IAutomationMetadataObject[];
    automationsCount: number;
    numberOfAvailableDestinations: number;
    widget: import("../../types/layoutTypes.js").ICustomWidget | import("@gooddata/sdk-model").IWidget | 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;
    onAlertingUpdateError: () => void;
    onAlertingUpdateSuccess: () => 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;
    onAlertingDeleteError: () => void;
    onAlertingDeleteSuccess: () => void;
    onAlertingManagementEdit: (alert: import("@gooddata/sdk-model").IAutomationMetadataObject, widget?: import("@gooddata/sdk-model").IWidget) => void;
    onAlertingManagementLoadingError: () => void;
}

Returns

{ alertToEdit: import("@gooddata/sdk-model").IAutomationMetadataObject | undefined; isInitialized: boolean; notificationChannels: import("@gooddata/sdk-model").INotificationChannelIdentifier[] | import("@gooddata/sdk-model").INotificationChannelMetadataObject[]; automations: import("@gooddata/sdk-model").IAutomationMetadataObject[]; automationsCount: number; numberOfAvailableDestinations: number; widget: import("../../types/layoutTypes.js").ICustomWidget | import("@gooddata/sdk-model").IWidget | 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; onAlertingUpdateError: () => void; onAlertingUpdateSuccess: () => 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; onAlertingDeleteError: () => void; onAlertingDeleteSuccess: () => void; onAlertingManagementEdit: (alert: import("@gooddata/sdk-model").IAutomationMetadataObject, widget?: import("@gooddata/sdk-model").IWidget) => void; onAlertingManagementLoadingError: () => void; }

useDashboardAlerts()

Related