Class SlackChannelAdapter

Channel adapter for Slack using the @slack/bolt SDK.

Uses dynamic import so @slack/bolt is only required at runtime when the adapter is actually initialized.

When appToken is provided, the adapter uses Socket Mode (no public endpoint required). Otherwise, it starts an HTTP server for receiving Slack events.

Capabilities: text, rich_text, images, documents, reactions, threads, mentions, buttons, group_chat, channels, editing, deletion.

Hierarchy (view full)

BaseChannelAdapter<SlackAuthParams>
- SlackChannelAdapter

Constructors

constructor

new SlackChannelAdapter(retryConfig?): SlackChannelAdapter
Parameters
- Optional retryConfig: Partial<RetryConfig>
Returns SlackChannelAdapter
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

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?: SlackAuthParams;
  }
Returns Promise<void>
Overrides BaseChannelAdapter.doConnect
- Defined in src/channels/adapters/SlackChannelAdapter.ts:103

`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/SlackChannelAdapter.ts:177

`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/SlackChannelAdapter.ts:198

editMessage

editMessage(conversationId, messageId, content): Promise<void>
Parameters
- conversationId: string
- messageId: string
- content: MessageContent
Returns Promise<void>
- Defined in src/channels/adapters/SlackChannelAdapter.ts:213

deleteMessage

deleteMessage(conversationId, messageId): Promise<void>
Parameters
- conversationId: string
- messageId: string
Returns Promise<void>
- Defined in src/channels/adapters/SlackChannelAdapter.ts:232

addReaction

addReaction(conversationId, messageId, emoji): Promise<void>
Parameters
- conversationId: string
- messageId: string
- emoji: string
Returns Promise<void>
- Defined in src/channels/adapters/SlackChannelAdapter.ts:244

sendTypingIndicator

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

getConversationInfo

getConversationInfo(conversationId): Promise<{
    name?: string;
    memberCount?: number;
    isGroup: boolean;
    metadata?: Record<string, unknown>;
}>
Parameters
- conversationId: string
Returns Promise<{
    name?: string;
    memberCount?: number;
    isGroup: boolean;
    metadata?: Record<string, unknown>;
}>
- Defined in src/channels/adapters/SlackChannelAdapter.ts:268

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?: SlackAuthParams;
}

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

`Protected` `Readonly` retryConfig

retryConfig: RetryConfig

`Readonly` platform

platform: ChannelPlatform = 'slack'

Platform this adapter serves.

`Readonly` displayName

displayName: "Slack" = 'Slack'

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

`Readonly` capabilities

capabilities: readonly ChannelCapability[] = ...

Declared capabilities of this adapter.

Class SlackChannelAdapter

Hierarchy (view full)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns SlackChannelAdapter

Methods

initialize

Parameters

Returns Promise<void>

shutdown

Returns Promise<void>

reconnect

Returns Promise<void>

getConnectionInfo

Returns ChannelConnectionInfo

sendMessage

Parameters

Returns Promise<ChannelSendResult>

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>

editMessage

Parameters

Returns Promise<void>

deleteMessage

Parameters

Returns Promise<void>

addReaction

Parameters

Returns Promise<void>

sendTypingIndicator

Parameters

Returns Promise<void>

getConversationInfo

Parameters

Returns Promise<{ name?: string; memberCount?: number; isGroup: boolean; metadata?: Record<string, unknown>; }>

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<{
name?: string;
memberCount?: number;
isGroup: boolean;
metadata?: Record<string, unknown>;
}>

`Protected` status

`Protected` connectedSince

`Protected` errorMessage

`Protected` platformInfo

`Protected` auth

`Protected` `Readonly` retryConfig

`Readonly` platform

`Readonly` displayName

`Readonly` capabilities