ChannelServiceHandler class

参考

包:: botbuilder

警告

现已弃用此 API。

Use CloudChannelServiceHandler instead. The ChannelServiceHandler implements API to forward activity to a skill and implements routing ChannelAPI calls from the Skill up through the bot/adapter.

Extends: ChannelServiceHandlerBase

构造函数

ChannelServiceHandler(ICredentialProvider, AuthenticationConfiguration, string)

使用凭据提供程序初始化 ChannelServiceHandler 类的新实例。

继承的方法

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)	处理企业时，将数据存储在合规的存储中。

构造函数详细信息

ChannelServiceHandler(ICredentialProvider, AuthenticationConfiguration, string)

使用凭据提供程序初始化 ChannelServiceHandler 类的新实例。

new ChannelServiceHandler(credentialProvider: ICredentialProvider, authConfig: AuthenticationConfiguration, channelService?: string)

参数

credentialProvider: ICredentialProvider

凭据提供程序。

authConfig: AuthenticationConfiguration

身份验证配置。

channelService: string

表示通道提供程序的字符串。

继承的方法详细信息

handleCreateConversation(string, ConversationParameters)

创建新的对话。

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

参数

authHeader: string

身份验证标头。

parameters: ConversationParameters

(xref：botbuilder-core。ConversationParameters) 创建会话。

Promise<ConversationResourceResponse>

Promise操作的表示形式。

继承自ChannelServiceHandlerBase.handleCreateConversation

handleDeleteActivity(string, string, string)

删除现有活动。

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

参数

authHeader: string

身份验证标头。

conversationId: string

对话 ID。

activityId: string

要删除的活动 ID。

Promise<void>

继承自ChannelServiceHandlerBase.handleDeleteActivity

handleDeleteConversationMember(string, string, string)

从对话中删除成员。

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

参数

authHeader: string

身份验证标头。

conversationId: string

对话 ID。

memberId: string

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

Promise<void>

继承自ChannelServiceHandlerBase.handleDeleteConversationMember

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 列表。

继承自ChannelServiceHandlerBase.handleGetActivityMembers

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 。

继承自ChannelServiceHandlerBase.handleGetConversationMember

handleGetConversationMembers(string, string)

枚举会话的成员。

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

参数

authHeader: string

身份验证标头。

conversationId: string

对话 ID。

Promise<ChannelAccount[]>

枚举的 ChannelAccount 列表。

继承自ChannelServiceHandlerBase.handleGetConversationMembers

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 ，表示操作的 PagedMembersResult 。

继承自ChannelServiceHandlerBase.handleGetConversationPagedMembers

handleGetConversations(string, string, string)

列出机器人参与的对话。

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

参数

authHeader: string

身份验证标头。

conversationId: string

对话 ID。

continuationToken: string

跳过或继续标记。

Promise<ConversationsResult>

Promise操作的表示形式。

继承自ChannelServiceHandlerBase.handleGetConversations

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 ，表示操作的 ResourceResponse 。

继承自ChannelServiceHandlerBase.handleReplyToActivity

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 ，表示操作的 ResourceResponse 。

继承自ChannelServiceHandlerBase.handleSendConversationHistory

handleSendToConversation(string, string, Activity)

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

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

参数

authHeader: string

身份验证标头。

conversationId: string

对话 ID。

activity: Activity

要发送的活动。

Promise<ResourceResponse>

一个 Promise ，表示操作的 ResourceResponse 。

继承自ChannelServiceHandlerBase.handleSendToConversation

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 ，表示操作的 ResourceResponse 。

继承自ChannelServiceHandlerBase.handleUpdateActivity

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 ，表示操作的 ResourceResponse 。

继承自ChannelServiceHandlerBase.handleUploadAttachment

通过

ChannelServiceHandler class

构造函数

继承的方法

构造函数详细信息

ChannelServiceHandler(ICredentialProvider, AuthenticationConfiguration, string)

参数

继承的方法详细信息

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)

参数

返回

其他资源