Interface INotificationUtils

Base interface for notification adapters. All notification adapters must implement this interface.

interface INotificationUtils {
    dispose(): Promise<void>;
    getData(): Promise<NotificationModel[]>;
    handleBreakeven(data: BreakevenContract): Promise<void>;
    handleCheck(data: OrderCheckContract): Promise<void>;
    handleCriticalError(error: Error): Promise<void>;
    handleError(error: Error): Promise<void>;
    handleOrderContinue(data: OrderContinueContract): Promise<void>;
    handleOrderFill(data: OrderFillContract): Promise<void>;
    handleOrderReject(data: OrderRejectContract): Promise<void>;
    handleOrderStop(data: OrderStopContract): Promise<void>;
    handlePartialLoss(data: PartialLossContract): Promise<void>;
    handlePartialProfit(data: PartialProfitContract): Promise<void>;
    handlePause(data: PauseContract): Promise<void>;
    handleRisk(data: RiskContract): Promise<void>;
    handleSignal(data: IStrategyTickResult): Promise<void>;
    handleSignalNotify(data: SignalInfoContract): Promise<void>;
    handleStrategyCommit(data: StrategyCommitContract): Promise<void>;
    handleSync(data: OrderSyncContract): Promise<void>;
    handleValidationError(error: Error): Promise<void>;
}

Index

Methods

dispose getData handleBreakeven handleCheck handleCriticalError handleError handleOrderContinue handleOrderFill handleOrderReject handleOrderStop handlePartialLoss handlePartialProfit handlePause handleRisk handleSignal handleSignalNotify handleStrategyCommit handleSync handleValidationError

Methods

dispose

dispose(): Promise<void>
Clears all stored notifications.

Returns Promise<void>
- Defined in types.d.ts:30216

getData

getData(): Promise<NotificationModel[]>
Gets all stored notifications.

Returns Promise<NotificationModel[]>
Array of all notification models
- Defined in types.d.ts:30212

handleBreakeven

handleBreakeven(data: BreakevenContract): Promise<void>
Handles breakeven availability event.
Parameters
- data: BreakevenContract
  The breakeven contract data
Returns Promise<void>
- Defined in types.d.ts:30147

handleCheck

handleCheck(data: OrderCheckContract): Promise<void>
Handles order-ping check event (signal-ping).
Parameters
- data: OrderCheckContract
  The order check contract data
Returns Promise<void>
- Defined in types.d.ts:30162

handleCriticalError

handleCriticalError(error: Error): Promise<void>
Handles critical error event.
Parameters
- error: Error
  The error object
Returns Promise<void>
- Defined in types.d.ts:30202

handleError

handleError(error: Error): Promise<void>
Handles error event.
Parameters
- error: Error
  The error object
Returns Promise<void>
- Defined in types.d.ts:30197

handleOrderContinue

handleOrderContinue(data: OrderContinueContract): Promise<void>
Handles post-verdict order-check continue event (order still open, monitoring continues).
Parameters
- data: OrderContinueContract
  The order continue contract data
Returns Promise<void>
- Defined in types.d.ts:30177

handleOrderFill

handleOrderFill(data: OrderFillContract): Promise<void>
Handles broker-confirmed order fill event (post-verdict, signal-open/signal-close).
Parameters
- data: OrderFillContract
  The order fill contract data
Returns Promise<void>
- Defined in types.d.ts:30167

handleOrderReject

handleOrderReject(data: OrderRejectContract): Promise<void>
Handles terminal order rejection event (post-verdict, signal-open/signal-close).
Parameters
- data: OrderRejectContract
  The order reject contract data
Returns Promise<void>
- Defined in types.d.ts:30172

handleOrderStop

handleOrderStop(data: OrderStopContract): Promise<void>
Handles post-verdict order-check stop event (terminal: order gone, teardown follows).
Parameters
- data: OrderStopContract
  The order stop contract data
Returns Promise<void>
- Defined in types.d.ts:30182

handlePartialLoss

handlePartialLoss(data: PartialLossContract): Promise<void>
Handles partial loss availability event.
Parameters
- data: PartialLossContract
  The partial loss contract data
Returns Promise<void>
- Defined in types.d.ts:30142

handlePartialProfit

handlePartialProfit(data: PartialProfitContract): Promise<void>
Handles partial profit availability event.
Parameters
- data: PartialProfitContract
  The partial profit contract data
Returns Promise<void>
- Defined in types.d.ts:30137

handlePause

handlePause(data: PauseContract): Promise<void>
Handles strategy pause state change event.
Parameters
- data: PauseContract
  The pause contract data
Returns Promise<void>
- Defined in types.d.ts:30192

handleRisk

handleRisk(data: RiskContract): Promise<void>
Handles risk rejection event.
Parameters
- data: RiskContract
  The risk contract data
Returns Promise<void>
- Defined in types.d.ts:30187

handleSignal

handleSignal(data: IStrategyTickResult): Promise<void>
Handles signal events (opened, closed, scheduled, cancelled).
Parameters
- data: IStrategyTickResult
  The strategy tick result data
Returns Promise<void>
- Defined in types.d.ts:30131

handleSignalNotify

handleSignalNotify(data: SignalInfoContract): Promise<void>
Parameters
- data: SignalInfoContract
Returns Promise<void>
- Defined in types.d.ts:30132

handleStrategyCommit

handleStrategyCommit(data: StrategyCommitContract): Promise<void>
Handles strategy commit events (partial-profit, breakeven, trailing, etc.).
Parameters
- data: StrategyCommitContract
  The strategy commit contract data
Returns Promise<void>
- Defined in types.d.ts:30152

handleSync

handleSync(data: OrderSyncContract): Promise<void>
Handles signal sync event (signal-open, signal-close).
Parameters
- data: OrderSyncContract
  The signal sync contract data
Returns Promise<void>
- Defined in types.d.ts:30157

handleValidationError

handleValidationError(error: Error): Promise<void>
Handles validation error event.
Parameters
- error: Error
  The error object
Returns Promise<void>
- Defined in types.d.ts:30207

Interface INotificationUtils

Index

Methods

Methods

dispose

Returns Promise<void>

getData

Returns Promise<NotificationModel[]>

handleBreakeven

Parameters

Returns Promise<void>

handleCheck

Parameters

Returns Promise<void>

handleCriticalError

Parameters

Returns Promise<void>

handleError

Parameters

Returns Promise<void>

handleOrderContinue

Parameters

Returns Promise<void>

handleOrderFill

Parameters

Returns Promise<void>

handleOrderReject

Parameters

Returns Promise<void>

handleOrderStop

Parameters

Returns Promise<void>

handlePartialLoss

Parameters

Returns Promise<void>

handlePartialProfit

Parameters

Returns Promise<void>

handlePause

Parameters

Returns Promise<void>

handleRisk

Parameters

Returns Promise<void>

handleSignal

Parameters

Returns Promise<void>

handleSignalNotify

Parameters

Returns Promise<void>

handleStrategyCommit

Parameters

Returns Promise<void>

handleSync

Parameters

Returns Promise<void>

handleValidationError

Parameters

Returns Promise<void>

Settings

On This Page