Abstract Class: BaseChannelAdapter<TAuthParams>

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:79

Abstract base class that implements common IChannelAdapter behaviour. Concrete adapters (Telegram, Discord, IRC, ...) extend this class and implement the three abstract hooks:

• doConnect(auth) -- establish the platform connection.
• doSendMessage(conversationId, content) -- deliver a message.
• doShutdown() -- tear down the platform connection.

Extended by

• TelegramChannelAdapter
• DiscordChannelAdapter
• SlackChannelAdapter
• WhatsAppChannelAdapter
• WebChatChannelAdapter
• TwitterChannelAdapter
• RedditChannelAdapter
• IRCChannelAdapter
• SignalChannelAdapter
• TeamsChannelAdapter
• GoogleChatChannelAdapter
• PlivoSmsChannelAdapter

Type Parameters

TAuthParams

TAuthParams extends Record<string, string | undefined> = Record<string, string>

Shape of the platform-specific params object inside ChannelAuthConfig. Defaults to Record<string, string>.

Implements

• IChannelAdapter

Constructors

Constructor

new BaseChannelAdapter<TAuthParams>(retryConfig?): BaseChannelAdapter<TAuthParams>

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:111

Parameters

retryConfig?

Partial<RetryConfig>

Returns

BaseChannelAdapter<TAuthParams>

Properties

auth

protected auth: ChannelAuthConfig & object | undefined

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:97

Stored auth config so reconnect() can re-use it.

---

capabilities

abstract readonly capabilities: readonly ChannelCapability[]

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:87

Declared capabilities of this adapter.

Implementation of

IChannelAdapter.capabilities

---

connectedSince

protected connectedSince: string | undefined

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:92

---

displayName

abstract readonly displayName: string

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:86

Human-readable display name (e.g., "WhatsApp Business").

Implementation of

IChannelAdapter.displayName

---

errorMessage

protected errorMessage: string | undefined

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:93

---

platform

abstract readonly platform: ChannelPlatform

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:85

Platform this adapter serves.

Implementation of

IChannelAdapter.platform

---

platformInfo

protected platformInfo: Record<string, unknown> = {}

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:94

---

retryConfig

protected readonly retryConfig: RetryConfig

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:101

---

status

protected status: ChannelConnectionStatus = 'disconnected'

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:91

Methods

doConnect()

abstract protected doConnect(auth): Promise<void>

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:124

Establish the platform connection using the supplied credentials. Called by initialize after state has been set to connecting. Must throw on failure — the base class handles retry and state changes.

Parameters

auth

ChannelAuthConfig & object

Returns

Promise<void>

---

doSendMessage()

abstract protected doSendMessage(conversationId, content): Promise<ChannelSendResult>

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:132

Deliver a message to the external platform. Called by sendMessage only when the adapter is connected.

Parameters

conversationId

string

content

MessageContent

Returns

Promise<ChannelSendResult>

---

doShutdown()

abstract protected doShutdown(): Promise<void>

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:141

Release platform resources (close WebSocket, stop polling, etc.). Called by shutdown before the state transitions to disconnected.

Returns

Promise<void>

---

emit()

protected emit(event): void

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:265

Emit an event to all matching subscribers. Subclasses call this when the platform SDK receives an inbound event.

Parameters

event

ChannelEvent

Returns

void

---

emitConnectionChange()

protected emitConnectionChange(): void

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:296

Convenience helper: emit a connection_change event with the current status. Called automatically by setStatus.

Returns

void

---

getConnectionInfo()

getConnectionInfo(): ChannelConnectionInfo

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:205

Get the current connection status and metadata.

Returns

ChannelConnectionInfo

Implementation of

IChannelAdapter.getConnectionInfo

---

hasCapability()

protected hasCapability(cap): boolean

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:312

Check whether this adapter declares a specific capability.

Parameters

cap

ChannelCapability

Returns

boolean

---

initialize()

initialize(auth): Promise<void>

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:151

Initialize the adapter with auth credentials. If already connected this will shut down the existing connection first (idempotent).

Parameters

auth

ChannelAuthConfig

Returns

Promise<void>

Implementation of

IChannelAdapter.initialize

---

on()

on(handler, eventTypes?): () => void

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:248

Register an event handler. Returns an unsubscribe function.

Parameters

handler

ChannelEventHandler

eventTypes?

ChannelEventType[]

Returns

(): void

Returns

void

Implementation of

IChannelAdapter.on

---

reconnect()

reconnect(): Promise<void>

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:186

Manually trigger a reconnection attempt using stored credentials. Useful for UI-driven "reconnect" buttons.

Returns

Promise<void>

---

sendMessage()

sendMessage(conversationId, content): Promise<ChannelSendResult>

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:218

Send a message to a conversation on the external platform.

Parameters

conversationId

string

Platform-native conversation/chat ID.

content

MessageContent

Message content to send.

Returns

Promise<ChannelSendResult>

The platform-assigned message ID.

Implementation of

IChannelAdapter.sendMessage

---

sendTypingIndicator()

sendTypingIndicator(_conversationId, _isTyping): Promise<void>

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:234

Default stub — platforms that support typing indicators should override.

Parameters

_conversationId

string

_isTyping

boolean

Returns

Promise<void>

Implementation of

IChannelAdapter.sendTypingIndicator

---

setStatus()

protected setStatus(newStatus, error?): void

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:319

Transition to a new connection status and emit an event.

Parameters

newStatus

ChannelConnectionStatus

error?

string

Returns

void

---

shutdown()

shutdown(): Promise<void>

Defined in: packages/agentos/src/io/channels/adapters/BaseChannelAdapter.ts:166

Gracefully shut down the adapter and release all resources.

Returns

Promise<void>

Implementation of

IChannelAdapter.shutdown