useDashboardScheduledEmails()

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

useDashboardScheduledEmails() 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 schedule emailing dialogs.

Signature:

useDashboardScheduledEmails: () => {
    scheduledExportToEdit: import("@gooddata/sdk-model").IAutomationMetadataObject | undefined;
    isInitialized: boolean;
    notificationChannels: 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;
    isScheduledEmailingVisible: boolean;
    isScheduleEmailingDialogOpen: boolean;
    defaultOnScheduleEmailing: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingOpen: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingCancel: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingBack: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingCreateError: () => void;
    onScheduleEmailingCreateSuccess: (scheduledEmail: import("@gooddata/sdk-model").IAutomationMetadataObject) => void;
    onScheduleEmailingSaveError: () => void;
    onScheduleEmailingSaveSuccess: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    isScheduledManagementEmailingVisible: boolean;
    isScheduleEmailingManagementDialogOpen: boolean;
    defaultOnScheduleEmailingManagement: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingManagementOpen: (widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingManagementEdit: (schedule: import("@gooddata/sdk-model").IAutomationMetadataObject, widget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingManagementAdd: (targetWidget?: import("@gooddata/sdk-model").IWidget) => void;
    onScheduleEmailingManagementClose: () => void;
    onScheduleEmailingManagementLoadingError: () => void;
    onScheduleEmailingManagementDeleteSuccess: () => void;
    onScheduleEmailingManagementDeleteError: () => void;
}

Returns:

{ scheduledExportToEdit: import("@gooddata/sdk-model").IAutomationMetadataObject | undefined; isInitialized: boolean; notificationChannels: 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; isScheduledEmailingVisible: boolean; isScheduleEmailingDialogOpen: boolean; defaultOnScheduleEmailing: (widget?: import("@gooddata/sdk-model").IWidget) => void; onScheduleEmailingOpen: (widget?: import("@gooddata/sdk-model").IWidget) => void; onScheduleEmailingCancel: (widget?: import("@gooddata/sdk-model").IWidget) => void; onScheduleEmailingBack: (widget?: import("@gooddata/sdk-model").IWidget) => void; onScheduleEmailingCreateError: () => void; onScheduleEmailingCreateSuccess: (scheduledEmail: import("@gooddata/sdk-model").IAutomationMetadataObject) => void; onScheduleEmailingSaveError: () => void; onScheduleEmailingSaveSuccess: (widget?: import("@gooddata/sdk-model").IWidget) => void; isScheduledManagementEmailingVisible: boolean; isScheduleEmailingManagementDialogOpen: boolean; defaultOnScheduleEmailingManagement: (widget?: import("@gooddata/sdk-model").IWidget) => void; onScheduleEmailingManagementOpen: (widget?: import("@gooddata/sdk-model").IWidget) => void; onScheduleEmailingManagementEdit: (schedule: import("@gooddata/sdk-model").IAutomationMetadataObject, widget?: import("@gooddata/sdk-model").IWidget) => void; onScheduleEmailingManagementAdd: (targetWidget?: import("@gooddata/sdk-model").IWidget) => void; onScheduleEmailingManagementClose: () => void; onScheduleEmailingManagementLoadingError: () => void; onScheduleEmailingManagementDeleteSuccess: () => void; onScheduleEmailingManagementDeleteError: () => void; }