ChannelServiceHandlerBase class

包:

botbuilder

ChannelServiceHandlerBase 实现 API 以将活动转发到技能，并通过机器人/适配器实现从技能向上路由 ChannelAPI 调用。

方法

handleCreateConversation(string, ConversationParameters)	创建新的对话。
handleDeleteActivity(string, string, string)	删除现有 活动。
handleDeleteConversationMember(string, string, string)	从对话中删除成员。
handleGetActivityMembers(string, string, string)	枚举 活动的成员。
handleGetConversationMember(string, string, string)	获取单个对话成员的帐户。
handleGetConversationMembers(string, string)	枚举会话的成员。
handleGetConversationPagedMembers(string, string, number, string)	枚举对话的成员一次一页。
handleGetConversations(string, string, string)	列出机器人参与的对话。
handleReplyToActivity(string, string, string, Activity)	发送对 活动的答复。
handleSendConversationHistory(string, string, Transcript)	上传对话的历史活动。
handleSendToConversation(string, string, Activity)	将 活动 发送到会话的末尾。
handleUpdateActivity(string, string, string, Activity)	编辑以前发送的现有 活动。
handleUploadAttachment(string, string, AttachmentData)	处理企业时，将数据存储在合规的存储中。

方法详细信息

handleCreateConversation(string, ConversationParameters)

创建新的对话。

function handleCreateConversation(authHeader: string, parameters: ConversationParameters): Promise<ConversationResourceResponse>

参数

authHeader

string

身份验证标头。

parameters

ConversationParameters

（xref：botbuilder-core。用于创建对话的 ConversationParameters。

返回

Promise<ConversationResourceResponse>

操作的 Promise 表示形式。

handleDeleteActivity(string, string, string)

删除现有 活动。

function handleDeleteActivity(authHeader: string, conversationId: string, activityId: string): Promise<void>

参数

authHeader

string

身份验证标头。

conversationId

string

对话 ID。

activityId

string

要删除的活动 ID。

返回

Promise<void>

handleDeleteConversationMember(string, string, string)

从对话中删除成员。

function handleDeleteConversationMember(authHeader: string, conversationId: string, memberId: string): Promise<void>

参数

authHeader

string

身份验证标头。

conversationId

string

对话 ID。

memberId

string

要从此对话中删除的成员的 ID。

返回

Promise<void>

handleGetActivityMembers(string, string, string)

枚举 活动的成员。

function handleGetActivityMembers(authHeader: string, conversationId: string, activityId: string): Promise<ChannelAccount[]>

参数

authHeader

string

身份验证标头。

conversationId

string

对话 ID。

activityId

string

活动 ID。

返回

Promise<ChannelAccount[]>

枚举的 channelAccount 列表 。

handleGetConversationMember(string, string, string)

获取单个对话成员的帐户。

function handleGetConversationMember(authHeader: string, userId: string, conversationId: string): Promise<ChannelAccount>

参数

authHeader

string

身份验证标头。

userId

string

用户 ID。

conversationId

string

对话 ID。

返回

Promise<ChannelAccount>

提供的用户 ID 的 ChannelAccount。

handleGetConversationMembers(string, string)

枚举会话的成员。

function handleGetConversationMembers(authHeader: string, conversationId: string): Promise<ChannelAccount[]>

参数

authHeader

string

身份验证标头。

conversationId

string

对话 ID。

返回

Promise<ChannelAccount[]>

枚举的 channelAccount 列表 。

handleGetConversationPagedMembers(string, string, number, string)

枚举对话的成员一次一页。

function handleGetConversationPagedMembers(authHeader: string, conversationId: string, pageSize?: number, continuationToken?: string): Promise<PagedMembersResult>

参数

authHeader

string

身份验证标头。

conversationId

string

对话 ID。

pageSize

number

建议的页面大小。

continuationToken

string

延续标记。

返回

Promise<PagedMembersResult>

表示操作的 Promise 的 。

handleGetConversations(string, string, string)

列出机器人参与的对话。

function handleGetConversations(authHeader: string, conversationId: string, continuationToken?: string): Promise<ConversationsResult>

参数

authHeader

string

身份验证标头。

conversationId

string

对话 ID。

continuationToken

string

跳过或继续标记。

返回

Promise<ConversationsResult>

操作的 Promise 表示形式。

handleReplyToActivity(string, string, string, Activity)

发送对 活动的答复。

function handleReplyToActivity(authHeader: string, conversationId: string, activityId: string, activity: Activity): Promise<ResourceResponse>

参数

authHeader

string

身份验证标头。

conversationId

string

对话 ID。

activityId

string

答复的活动 ID。

activity

Activity

要发送 活动。

返回

Promise<ResourceResponse>

表示操作的 Promise 的 。

handleSendConversationHistory(string, string, Transcript)

上传对话的历史活动。

function handleSendConversationHistory(authHeader: string, conversationId: string, transcript: Transcript): Promise<ResourceResponse>

参数

authHeader

string

身份验证标头。

conversationId

string

对话 ID。

transcript

Transcript

（xref：botframework-schema。活动的脚本。

返回

Promise<ResourceResponse>

表示操作的 Promise 的 。

handleSendToConversation(string, string, Activity)

将 活动 发送到会话的末尾。

function handleSendToConversation(authHeader: string, conversationId: string, activity: Activity): Promise<ResourceResponse>

参数

authHeader

string

身份验证标头。

conversationId

string

对话 ID。

activity

Activity

要发送 活动。

返回

Promise<ResourceResponse>

表示操作的 Promise 的 。

handleUpdateActivity(string, string, string, Activity)

编辑以前发送的现有 活动。

function handleUpdateActivity(authHeader: string, conversationId: string, activityId: string, activity: Activity): Promise<ResourceResponse>

参数

authHeader

string

身份验证标头。

conversationId

string

对话 ID。

activityId

string

要更新的活动 ID。

activity

Activity

替换 活动。

返回

Promise<ResourceResponse>

表示操作的 Promise 的 。

handleUploadAttachment(string, string, AttachmentData)

处理企业时，将数据存储在合规的存储中。

function handleUploadAttachment(authHeader: string, conversationId: string, attachmentUpload: AttachmentData): Promise<ResourceResponse>

参数

authHeader

string

身份验证标头。

conversationId

string

对话 ID。

attachmentUpload

AttachmentData

（xref：botframework-schema。AttachmentData）。

返回

Promise<ResourceResponse>

表示操作的 Promise 的 。