useDashboardScheduledEmails()

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

Hook that handles schedule emailing dialogs.

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("../../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;
    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;
    onScheduleEmailingUpdateError: () => void;
    onScheduleEmailingUpdateSuccess: () => 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;
    onScheduleEmailingDeleteSuccess: () => void;
    onScheduleEmailingDeleteError: () => 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("../../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; 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; onScheduleEmailingUpdateError: () => void; onScheduleEmailingUpdateSuccess: () => 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; onScheduleEmailingDeleteSuccess: () => void; onScheduleEmailingDeleteError: () => void; }

useDashboardScheduledEmails()

Related