Class IListener`Abstract`

Abstract base for all platform listeners. Each platform (Discord, WhatsApp, Slack) implements this.

Hierarchy

EventEmitter
- IListener

Index

Constructors

Properties

Methods

configure isConnected start stop

Constructors

constructor

new IListener(options?: EventEmitterOptions): IListener
Parameters
- Optionaloptions: EventEmitterOptions
Returns IListener
Inherited from EventEmitter.constructor
- Defined in node_modules/@types/node/events.d.ts:101

Properties

`Abstract` `Readonly`id

id: string

Unique identifier for this listener instance

`Abstract` `Readonly`platform

platform: Platform

Platform this listener connects to

Methods

`Abstract`configure

configure(config: Record<string, unknown>): void
Lifecycle hook called after construction to set up schemas.
Parameters
- config: Record<string, unknown>
Returns void
- Defined in packages/core/src/listener/IListener.ts:34

`Abstract`isConnected

isConnected(): boolean
Returns true if the listener is currently connected.

Returns boolean
- Defined in packages/core/src/listener/IListener.ts:29

`Abstract`start

start(): Promise<void>
Start the listener (connect to platform, begin ingesting). Emits 'message' (MessageEvent) for each matched message.

Returns Promise<void>
- Defined in packages/core/src/listener/IListener.ts:19

`Abstract`stop

stop(): Promise<void>
Gracefully stop the listener.

Returns Promise<void>
- Defined in packages/core/src/listener/IListener.ts:24