Interface MessagingChannelPayload

Payload shape for messaging-channel extension descriptors.

Extension packs register this as the payload of an ExtensionDescriptor<MessagingChannelPayload> with kind: 'messaging-channel'.

interface MessagingChannelPayload {
    platform: ChannelPlatform;
    displayName: string;
    capabilities: ChannelCapability[];
    initialize(auth): Promise<void>;
    shutdown(): Promise<void>;
    sendMessage(conversationId, content): Promise<ChannelSendResult>;
    sendTypingIndicator(conversationId, isTyping): Promise<void>;
    on(handler, eventTypes?): (() => void);
    getConnectionInfo(): ChannelConnectionInfo;
}

Index

Methods

initialize shutdown sendMessage sendTypingIndicator on getConnectionInfo

Properties

platform displayName capabilities

Methods

initialize

initialize(auth): Promise<void>
Initialize with credentials.
Parameters
- auth: ChannelAuthConfig
Returns Promise<void>
- Defined in src/extensions/MessagingChannelPayload.ts:39

shutdown

shutdown(): Promise<void>
Graceful shutdown.

Returns Promise<void>
- Defined in src/extensions/MessagingChannelPayload.ts:41

sendMessage

sendMessage(conversationId, content): Promise<ChannelSendResult>
Send a message to a conversation.
Parameters
- conversationId: string
- content: MessageContent
Returns Promise<ChannelSendResult>
- Defined in src/extensions/MessagingChannelPayload.ts:44

sendTypingIndicator

sendTypingIndicator(conversationId, isTyping): Promise<void>
Show/hide typing indicator.
Parameters
- conversationId: string
- isTyping: boolean
Returns Promise<void>
- Defined in src/extensions/MessagingChannelPayload.ts:46

on

on(handler, eventTypes?): (() => void)
Subscribe to events. Returns unsubscribe function.
Parameters
- handler: ChannelEventHandler
- Optional eventTypes: ChannelEventType[]
Returns (() => void)
- - (): void
  - Returns void
- Defined in src/extensions/MessagingChannelPayload.ts:49

getConnectionInfo

getConnectionInfo(): ChannelConnectionInfo
Get current connection status.

Returns ChannelConnectionInfo
- Defined in src/extensions/MessagingChannelPayload.ts:52

Properties

platform

platform: ChannelPlatform

Platform identifier (e.g., 'telegram', 'discord').

displayName

displayName: string

Human-friendly display name.

capabilities

capabilities: ChannelCapability[]

Capabilities this channel supports.