Interface: CallbackActionOptions
Defined in: redux/clusterActionSlice.ts:85
Properties
callbackArgs?
optional callbackArgs?: any[];
Defined in: redux/clusterActionSlice.ts:86
cancelCallback?
optional cancelCallback?: (...args: any[]) => void;
Defined in: redux/clusterActionSlice.ts:138
A callback to execute when the action is cancelled.
Parameters
| Parameter | Type |
|---|---|
...args | any[] |
Returns
void
cancelledMessage?
optional cancelledMessage?: string;
Defined in: redux/clusterActionSlice.ts:110
The message to display when the action is cancelled.
cancelledOptions?
optional cancelledOptions?: OptionsObject<"default" | "warning" | "error" | "success" | "info">;
Defined in: redux/clusterActionSlice.ts:126
The props to pass to the snackbar when the action is cancelled.
cancelUrl?
optional cancelUrl?: string;
Defined in: redux/clusterActionSlice.ts:94
The url to navigate to when it is cancelled.
errorMessage?
optional errorMessage?: string;
Defined in: redux/clusterActionSlice.ts:114
The message to display when there is an error.
errorMessageFormatter?
optional errorMessageFormatter?: (error: Error) => string;
Defined in: redux/clusterActionSlice.ts:143
Synchronously formats the error message. Empty results or synchronous exceptions fall back to the default message; exceptions are logged.
Parameters
| Parameter | Type |
|---|---|
error | Error |
Returns
string
errorOptions?
optional errorOptions?: OptionsObject<"default" | "warning" | "error" | "success" | "info">;
Defined in: redux/clusterActionSlice.ts:134
The props to pass to the snackbar when it is successful.
errorUrl?
optional errorUrl?: string;
Defined in: redux/clusterActionSlice.ts:98
The url to navigate to when there is an error.
onCancelled?
optional onCancelled?: () => void;
Defined in: redux/clusterActionSlice.ts:158
Called synchronously on cancellation, not awaited. Synchronous exceptions are logged without changing the action outcome.
Returns
void
onError?
optional onError?: (error: Error) => void;
Defined in: redux/clusterActionSlice.ts:153
Called synchronously on failure, not awaited. Synchronous exceptions are logged without changing the action outcome.
Parameters
| Parameter | Type |
|---|---|
error | Error |
Returns
void
onSuccess?
optional onSuccess?: () => void;
Defined in: redux/clusterActionSlice.ts:148
Called synchronously on success, not awaited. Synchronous exceptions are logged without changing the action outcome.
Returns
void
startMessage?
optional startMessage?: string;
Defined in: redux/clusterActionSlice.ts:106
The message to display when the action has started.
startOptions?
optional startOptions?: OptionsObject<"default" | "warning" | "error" | "success" | "info">;
Defined in: redux/clusterActionSlice.ts:122
The props to pass to the snackbar when the action has started.
startUrl?
optional startUrl?: string;
Defined in: redux/clusterActionSlice.ts:90
The url to navigate to when the action has started.
successMessage?
optional successMessage?: string;
Defined in: redux/clusterActionSlice.ts:118
The message to display when it is successful.
successOptions?
optional successOptions?: OptionsObject<"default" | "warning" | "error" | "success" | "info">;
Defined in: redux/clusterActionSlice.ts:130
The props to pass to the snackbar when there is an error.
successUrl?
optional successUrl?: string;
Defined in: redux/clusterActionSlice.ts:102
The url to navigate to when it is successful.