Interface IActionManager<T>

Interface for managing actions of type HsAction<T>.

interface IActionManager<T> {
    cancelPendingAction(action: null | HsAction.HsAction<T>): void;
    handleAction(action: HsAction.HsAction<T>): boolean;
    isActionValid(action: HsAction.HsAction<T>): boolean;
    manageAction(): boolean;
}

Type Parameters

T
The type of the payload or data associated with the action.

Implemented by

ActionManager

Index

Methods

cancelPendingAction handleAction isActionValid manageAction

Methods

cancelPendingAction

cancelPendingAction(action: null | HsAction.HsAction<T>): void
Cancels a pending action if one exists.
Parameters
- action: null | HsAction.HsAction<T>
  The action to cancel, or null if there is no action to cancel.
Returns void
- Defined in hosanna-ui/src/hosanna-ui/action/action-api.ts:31

handleAction

handleAction(action: HsAction.HsAction<T>): boolean
Handles the provided action.
Parameters
- action: HsAction.HsAction<T>
  The action to handle.
Returns boolean
true if the action was handled successfully, otherwise false.
- Defined in hosanna-ui/src/hosanna-ui/action/action-api.ts:16

isActionValid

isActionValid(action: HsAction.HsAction<T>): boolean
Checks if the provided action is valid.
Parameters
- action: HsAction.HsAction<T>
  The action to validate.
Returns boolean
true if the action is valid, otherwise false.
- Defined in hosanna-ui/src/hosanna-ui/action/action-api.ts:24

manageAction

manageAction(): boolean
Manages the current action.

Returns boolean
true if the action was managed successfully, otherwise false.
- Defined in hosanna-ui/src/hosanna-ui/action/action-api.ts:38