Class SignalChannelAdapter

Channel adapter for the Signal messaging protocol via signal-cli.

Capabilities: text, images, audio, voice_notes, documents, reactions, group_chat.

Conversation ID mapping:

Direct message: phone number (e.g., '+1234567890')
Group: group ID in base64 format, prefixed with 'group:'

Hierarchy (view full)

BaseChannelAdapter<SignalAuthParams>
- SignalChannelAdapter

Constructors

constructor

new SignalChannelAdapter(retryConfig?): SignalChannelAdapter
Parameters
- Optional retryConfig: Partial<RetryConfig>
Returns SignalChannelAdapter
Inherited from BaseChannelAdapter.constructor
- Defined in src/channels/adapters/BaseChannelAdapter.ts:111

Methods

initialize

initialize(auth): Promise<void>
Initialize the adapter with auth credentials. If already connected this will shut down the existing connection first (idempotent).
Parameters
- auth: ChannelAuthConfig
Returns Promise<void>
Inherited from BaseChannelAdapter.initialize
- Defined in src/channels/adapters/BaseChannelAdapter.ts:151

shutdown

shutdown(): Promise<void>
Gracefully shut down the adapter and release all resources.

Returns Promise<void>
Inherited from BaseChannelAdapter.shutdown
- Defined in src/channels/adapters/BaseChannelAdapter.ts:166

reconnect

reconnect(): Promise<void>
Manually trigger a reconnection attempt using stored credentials. Useful for UI-driven "reconnect" buttons.

Returns Promise<void>
Inherited from BaseChannelAdapter.reconnect
- Defined in src/channels/adapters/BaseChannelAdapter.ts:186

getConnectionInfo

getConnectionInfo(): ChannelConnectionInfo
Get the current connection status and metadata.

Returns ChannelConnectionInfo
Inherited from BaseChannelAdapter.getConnectionInfo
- Defined in src/channels/adapters/BaseChannelAdapter.ts:205

sendMessage

sendMessage(conversationId, content): Promise<ChannelSendResult>
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.
Inherited from BaseChannelAdapter.sendMessage
- Defined in src/channels/adapters/BaseChannelAdapter.ts:218

sendTypingIndicator

sendTypingIndicator(_conversationId, _isTyping): Promise<void>
Default stub — platforms that support typing indicators should override.
Parameters
- _conversationId: string
- _isTyping: boolean
Returns Promise<void>
Inherited from BaseChannelAdapter.sendTypingIndicator
- Defined in src/channels/adapters/BaseChannelAdapter.ts:234

on

on(handler, eventTypes?): (() => void)
Register an event handler. Returns an unsubscribe function.
Parameters
- handler: ChannelEventHandler
- Optional eventTypes: ChannelEventType[]
Returns (() => void)
- - (): void
  - Returns void
Inherited from BaseChannelAdapter.on
- Defined in src/channels/adapters/BaseChannelAdapter.ts:248

`Protected` emit

emit(event): void
Emit an event to all matching subscribers. Subclasses call this when the platform SDK receives an inbound event.
Parameters
- event: ChannelEvent<unknown>
Returns void
Inherited from BaseChannelAdapter.emit
- Defined in src/channels/adapters/BaseChannelAdapter.ts:265

`Protected` emitConnectionChange

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

Returns void
Inherited from BaseChannelAdapter.emitConnectionChange
- Defined in src/channels/adapters/BaseChannelAdapter.ts:296

`Protected` hasCapability

hasCapability(cap): boolean
Check whether this adapter declares a specific capability.
Parameters
- cap: ChannelCapability
Returns boolean
Inherited from BaseChannelAdapter.hasCapability
- Defined in src/channels/adapters/BaseChannelAdapter.ts:312

`Protected` setStatus

setStatus(newStatus, error?): void
Transition to a new connection status and emit an event.
Parameters
- newStatus: ChannelConnectionStatus
- Optional error: string
Returns void
Inherited from BaseChannelAdapter.setStatus
- Defined in src/channels/adapters/BaseChannelAdapter.ts:319

`Protected` doConnect

doConnect(auth): Promise<void>
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 & {
  params?: SignalAuthParams;
  }
Returns Promise<void>
Overrides BaseChannelAdapter.doConnect
- Defined in src/channels/adapters/SignalChannelAdapter.ts:113

`Protected` doSendMessage

doSendMessage(conversationId, content): Promise<ChannelSendResult>
Deliver a message to the external platform. Called by sendMessage only when the adapter is connected.
Parameters
- conversationId: string
- content: MessageContent
Returns Promise<ChannelSendResult>
Overrides BaseChannelAdapter.doSendMessage
- Defined in src/channels/adapters/SignalChannelAdapter.ts:156

`Protected` doShutdown

doShutdown(): Promise<void>
Release platform resources (close WebSocket, stop polling, etc.). Called by shutdown before the state transitions to disconnected.

Returns Promise<void>
Overrides BaseChannelAdapter.doShutdown
- Defined in src/channels/adapters/SignalChannelAdapter.ts:206

sendReaction

sendReaction(conversationId, targetAuthor, targetTimestamp, emoji): Promise<void>
Send a reaction to a message.
Parameters
- conversationId: string
  Target conversation (phone number or group:id).
- targetAuthor: string
  Phone number of the message author being reacted to.
- targetTimestamp: string
  Timestamp of the target message (Signal's message ID).
- emoji: string
  The reaction emoji.
Returns Promise<void>
- Defined in src/channels/adapters/SignalChannelAdapter.ts:248

listGroups

listGroups(): Promise<{
    id: string;
    name: string;
    members: string[];
}[]>
List groups the account is a member of.

Returns Promise<{
    id: string;
    name: string;
    members: string[];
}[]>
- Defined in src/channels/adapters/SignalChannelAdapter.ts:276

markAsRead

markAsRead(senderNumber, timestamps): Promise<void>
Mark messages as read (send read receipt).
Parameters
- senderNumber: string
- timestamps: string[]
Returns Promise<void>
- Defined in src/channels/adapters/SignalChannelAdapter.ts:297

Properties

`Protected` status

status: ChannelConnectionStatus = 'disconnected'

`Protected` connectedSince

connectedSince: undefined | string

`Protected` errorMessage

errorMessage: undefined | string

`Protected` platformInfo

platformInfo: Record<string, unknown> = {}

`Protected` auth

auth: undefined | ChannelAuthConfig & {
params?: SignalAuthParams;
}

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

`Protected` `Readonly` retryConfig

retryConfig: RetryConfig

`Readonly` platform

platform: ChannelPlatform = 'signal'

Platform this adapter serves.

`Readonly` displayName

displayName: "Signal" = 'Signal'

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

`Readonly` capabilities

capabilities: readonly ChannelCapability[] = ...

Declared capabilities of this adapter.

Class SignalChannelAdapter

Hierarchy (view full)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns SignalChannelAdapter

Methods

initialize

Parameters

Returns Promise<void>

shutdown

Returns Promise<void>

reconnect

Returns Promise<void>

getConnectionInfo

Returns ChannelConnectionInfo

sendMessage

Parameters

Returns Promise<ChannelSendResult>

sendTypingIndicator

Parameters

Returns Promise<void>

on

Parameters

Returns (() => void)

Returns void

Protected emit

Parameters

Returns void

Protected emitConnectionChange

Returns void

Protected hasCapability

Parameters

Returns boolean

Protected setStatus

Parameters

Returns void

Protected doConnect

Parameters

Returns Promise<void>

Protected doSendMessage

Parameters

Returns Promise<ChannelSendResult>

Protected doShutdown

Returns Promise<void>

sendReaction

Parameters

Returns Promise<void>

listGroups

Returns Promise<{ id: string; name: string; members: string[]; }[]>

markAsRead

Parameters

Returns Promise<void>

Properties

Protected status

Protected connectedSince

Protected errorMessage

Protected platformInfo

Protected auth

Protected Readonly retryConfig

Readonly platform

Readonly displayName

Readonly capabilities

Settings

Member Visibility

Theme

On This Page

`Protected` emit

`Protected` emitConnectionChange

`Protected` hasCapability

`Protected` setStatus

`Protected` doConnect

`Protected` doSendMessage

`Protected` doShutdown

Returns Promise<{
id: string;
name: string;
members: string[];
}[]>

`Protected` status

`Protected` connectedSince

`Protected` errorMessage

`Protected` platformInfo

`Protected` auth

`Protected` `Readonly` retryConfig

`Readonly` platform

`Readonly` displayName

`Readonly` capabilities