Skip to main content

Interface: MessagingChannelPayload

Defined in: packages/agentos/src/extensions/MessagingChannelPayload.ts:30

Payload shape for messaging-channel extension descriptors.

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

Properties​

capabilities​

capabilities: ChannelCapability[]

Defined in: packages/agentos/src/extensions/MessagingChannelPayload.ts:36

Capabilities this channel supports.


displayName​

displayName: string

Defined in: packages/agentos/src/extensions/MessagingChannelPayload.ts:34

Human-friendly display name.


platform​

platform: ChannelPlatform

Defined in: packages/agentos/src/extensions/MessagingChannelPayload.ts:32

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

Methods​

getConnectionInfo()​

getConnectionInfo(): ChannelConnectionInfo

Defined in: packages/agentos/src/extensions/MessagingChannelPayload.ts:52

Get current connection status.

Returns​

ChannelConnectionInfo


initialize()​

initialize(auth): Promise<void>

Defined in: packages/agentos/src/extensions/MessagingChannelPayload.ts:39

Initialize with credentials.

Parameters​

auth​

ChannelAuthConfig

Returns​

Promise<void>


on()​

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

Defined in: packages/agentos/src/extensions/MessagingChannelPayload.ts:49

Subscribe to events. Returns unsubscribe function.

Parameters​

handler​

ChannelEventHandler

eventTypes?​

ChannelEventType[]

Returns​

(): void

Returns​

void


sendMessage()​

sendMessage(conversationId, content): Promise<ChannelSendResult>

Defined in: packages/agentos/src/extensions/MessagingChannelPayload.ts:44

Send a message to a conversation.

Parameters​

conversationId​

string

content​

MessageContent

Returns​

Promise<ChannelSendResult>


sendTypingIndicator()​

sendTypingIndicator(conversationId, isTyping): Promise<void>

Defined in: packages/agentos/src/extensions/MessagingChannelPayload.ts:46

Show/hide typing indicator.

Parameters​

conversationId​

string

isTyping​

boolean

Returns​

Promise<void>


shutdown()​

shutdown(): Promise<void>

Defined in: packages/agentos/src/extensions/MessagingChannelPayload.ts:41

Graceful shutdown.

Returns​

Promise<void>