mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 06:00:43 +00:00
docs: remove bundled channel examples from core types
This commit is contained in:
@@ -56,10 +56,11 @@ export type AgentCommandOpts = {
|
||||
replyAccountId?: string;
|
||||
/** Override delivery thread/topic id (separate from session routing). */
|
||||
threadId?: string | number;
|
||||
/** Message channel context (webchat|voicewake|whatsapp|...). */
|
||||
/** Message channel context. */
|
||||
messageChannel?: string;
|
||||
channel?: string; // delivery channel (whatsapp|telegram|...)
|
||||
/** Account ID for multi-account channel routing (e.g., WhatsApp account). */
|
||||
/** Delivery channel. */
|
||||
channel?: string;
|
||||
/** Account ID for multi-account channel routing. */
|
||||
accountId?: string;
|
||||
/** Context for embedded run routing (channel/account/thread). */
|
||||
runContext?: AgentRunContext;
|
||||
|
||||
@@ -30,7 +30,7 @@ export type RunEmbeddedPiAgentParams = {
|
||||
trigger?: EmbeddedRunTrigger;
|
||||
/** Relative workspace path that memory-triggered writes are allowed to append to. */
|
||||
memoryFlushWritePath?: string;
|
||||
/** Delivery target (e.g. telegram:group:123:topic:456) for topic/thread routing. */
|
||||
/** Delivery target for topic/thread routing. */
|
||||
messageTo?: string;
|
||||
/** Thread/topic identifier for routing replies to the originating thread. */
|
||||
messageThreadId?: string | number;
|
||||
|
||||
@@ -140,8 +140,8 @@ export type EmbeddedPiRunResult = {
|
||||
audioAsVoice?: boolean;
|
||||
}>;
|
||||
meta: EmbeddedPiRunMeta;
|
||||
// True if a messaging tool (telegram, whatsapp, discord, slack, sessions_send)
|
||||
// successfully sent a message. Used to suppress agent's confirmation text.
|
||||
// True if a messaging tool successfully sent a message.
|
||||
// Used to suppress agent's confirmation text.
|
||||
didSendViaMessagingTool?: boolean;
|
||||
// Texts successfully sent via messaging tools during the run.
|
||||
messagingToolSentTexts?: string[];
|
||||
|
||||
@@ -40,7 +40,7 @@ function loadDeliverRuntime() {
|
||||
export type RouteReplyParams = {
|
||||
/** The reply payload to send. */
|
||||
payload: ReplyPayload;
|
||||
/** The originating channel type (telegram, slack, etc). */
|
||||
/** The originating channel type. */
|
||||
channel: OriginatingChannelType;
|
||||
/** The destination chat/channel/user ID. */
|
||||
to: string;
|
||||
|
||||
@@ -142,9 +142,9 @@ export type MsgContext = {
|
||||
SenderTag?: string;
|
||||
SenderE164?: string;
|
||||
Timestamp?: number;
|
||||
/** Provider label (e.g. whatsapp, telegram). */
|
||||
/** Provider label. */
|
||||
Provider?: string;
|
||||
/** Provider surface label (e.g. discord, slack). Prefer this over `Provider` when available. */
|
||||
/** Provider surface label. Prefer this over `Provider` when available. */
|
||||
Surface?: string;
|
||||
/** Platform bot username when command mentions should be normalized. */
|
||||
BotUsername?: string;
|
||||
|
||||
@@ -298,7 +298,7 @@ export type ChannelGatewayContext<ResolvedAccount = unknown> = {
|
||||
* ## Backward Compatibility
|
||||
*
|
||||
* - This field is **optional** - channels that don't need it can ignore it
|
||||
* - Built-in channels (slack, discord, etc.) typically don't use this field
|
||||
* - Bundled channels typically don't use this field
|
||||
* because they can directly import internal modules
|
||||
* - External plugins should check for undefined before using
|
||||
* - When provided, this must be a full `createPluginRuntime().channel` surface;
|
||||
|
||||
@@ -129,8 +129,8 @@ type ChannelManagerOptions = {
|
||||
* plugins to access advanced Plugin SDK features (AI dispatch, routing,
|
||||
* text processing, etc.).
|
||||
*
|
||||
* Built-in channels (slack, discord, telegram) typically don't use this
|
||||
* because they can directly import internal modules from the monorepo.
|
||||
* Bundled channels typically don't use this because they can directly
|
||||
* import internal modules from the monorepo.
|
||||
*
|
||||
* This field is optional - omitting it maintains backward compatibility
|
||||
* with existing channels. When provided, it must be a real
|
||||
|
||||
Reference in New Issue
Block a user