Class default

A class for managing blockchain events.

Index

Constructors

constructor

new default(ain): default
Creates a new EventManager object.
Parameters
- ain: default
  The Ain object.
Returns default
- Defined in src/event-manager/index.ts:34

Properties

`Private` `Readonly` _eventCallbackManager

_eventCallbackManager: default

The event callback manager.

`Private` `Readonly` _eventChannelClient

_eventChannelClient: default

The event channel client.

Methods

connect

connect(connectionCallback?, disconnectionCallback?, customClientId?): Promise<void>
Opens a new event channel.
Parameters
- Optional connectionCallback: ConnectionCallback
- Optional disconnectionCallback: DisconnectionCallback
  The disconnection callback function.
- Optional customClientId: string
  The custom client id to set.
Returns Promise<void>
- Defined in src/event-manager/index.ts:52

disconnect

disconnect(): void
Closes the current event channel.

Returns void
- Defined in src/event-manager/index.ts:59

getCustomClientId

getCustomClientId(): string
Returns the custom client id of the event channel saved on the client side.

Returns string
- Defined in src/event-manager/index.ts:66

isConnected

isConnected(): boolean
Returns whether the client in connection.

Returns boolean
- Defined in src/event-manager/index.ts:42

subscribe(eventType, config, eventCallback?, errorCallback?): string
Subscribes to blockchain events.
Parameters
- eventType: "BLOCK_FINALIZED"
- config: BlockFinalizedEventConfig
  The blockchain event configuraiton.
- Optional eventCallback: ((event) => void)
  The blockchain event callback function.
  - - (event): void
    - Parameters
      event: BlockFinalizedEvent
      Returns void
- Optional errorCallback: BlockchainErrorCallback
  The blockchain error callback function.
Returns string
The created filter ID.
- Defined in src/event-manager/index.ts:70
subscribe(eventType, config, eventCallback?, errorCallback?): string
Subscribes to blockchain events.
Parameters
- eventType: "VALUE_CHANGED"
- config: ValueChangedEventConfig
  The blockchain event configuraiton.
- Optional eventCallback: ((event) => void)
  The blockchain event callback function.
  - - (event): void
    - Parameters
      event: ValueChangedEvent
      Returns void
- Optional errorCallback: BlockchainErrorCallback
  The blockchain error callback function.
Returns string
The created filter ID.
- Defined in src/event-manager/index.ts:76
subscribe(eventType, config, eventCallback?, errorCallback?, filterDeletedEventCallback?): string
Subscribes to blockchain events.
Parameters
- eventType: "TX_STATE_CHANGED"
- config: TxStateChangedEventConfig
  The blockchain event configuraiton.
- Optional eventCallback: ((event) => void)
  The blockchain event callback function.
  - - (event): void
    - Parameters
      event: TxStateChangedEvent
      Returns void
- Optional errorCallback: BlockchainErrorCallback
  The blockchain error callback function.
- Optional filterDeletedEventCallback: FilterDeletedEventCallback
  The filter-deleted event callback function.
Returns string
The created filter ID.
- Defined in src/event-manager/index.ts:82

unsubscribe

unsubscribe(filterId, callback): void
Cancel a subscription.
Parameters
- filterId: string
  The filter ID of the subscription to cancel.
- callback: ErrorFirstCallback<default>
  The error handling callback function.
Returns void
- Defined in src/event-manager/index.ts:119

Class default

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

Private Readonly _eventCallbackManager

Private Readonly _eventChannelClient

Methods

connect

Parameters

Returns Promise<void>

disconnect

Returns void

getCustomClientId

Returns string

isConnected

Returns boolean

subscribe

Parameters

Parameters

Returns void

Returns string

Parameters

Parameters

Returns void

Returns string

Parameters

Parameters

Returns void

Returns string

unsubscribe

Parameters

Returns void

On This Page

`Private` `Readonly` _eventCallbackManager

`Private` `Readonly` _eventChannelClient