IAutomationDialogCallbacks
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Lifecycle callbacks shared by the alerting and scheduled email create/edit dialogs.
export interface IAutomationDialogCallbacks
Remarks
There is no pre-backend observer callback: the observation seam is the dialog context accessors and the caller-owned submit hook.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
() => void | (BETA) (Optional) Called when the user dismisses the dialog without saving. | ||
(error: GoodDataSdkError) => void | (BETA) (Optional) Called when creating a new automation on the backend fails, with the error. | ||
(automation: IAutomationMetadataObject) => void | (BETA) (Optional) Called after a new automation has been created on the backend, with the created automation. | ||
(error: GoodDataSdkError) => void | (BETA) (Optional) Called when deleting the automation from the backend (or unsubscribing from it) fails, with the error. | ||
(automation: IAutomationMetadataObject) => void | (BETA) (Optional) Called after the automation has been deleted from the backend, or unsubscribed from when the current user may not delete it, with that automation. | ||
(error: GoodDataSdkError) => void | (BETA) (Optional) Called when updating an existing automation on the backend fails, with the error. | ||
(automation: IAutomationMetadataObject) => void | (BETA) (Optional) Called after an existing automation has been updated on the backend, with the updated automation. |
Property details
IAutomationDialogCallbacks.onCancelpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called when the user dismisses the dialog without saving.
onCancel?: () => void;
IAutomationDialogCallbacks.onCreateErrorpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called when creating a new automation on the backend fails, with the error.
onCreateError?: (error: GoodDataSdkError) => void;
IAutomationDialogCallbacks.onCreateSuccesspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called after a new automation has been created on the backend, with the created automation.
onCreateSuccess?: (automation: IAutomationMetadataObject) => void;
IAutomationDialogCallbacks.onDeleteErrorpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called when deleting the automation from the backend (or unsubscribing from it) fails, with the error.
onDeleteError?: (error: GoodDataSdkError) => void;
IAutomationDialogCallbacks.onDeleteSuccesspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called after the automation has been deleted from the backend, or unsubscribed from when the current user may not delete it, with that automation.
onDeleteSuccess?: (automation: IAutomationMetadataObject) => void;
IAutomationDialogCallbacks.onUpdateErrorpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called when updating an existing automation on the backend fails, with the error.
onUpdateError?: (error: GoodDataSdkError) => void;
IAutomationDialogCallbacks.onUpdateSuccesspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called after an existing automation has been updated on the backend, with the updated automation.
onUpdateSuccess?: (automation: IAutomationMetadataObject) => void;