Conversations class
表示对话的类。
构造函数
Conversations(Connector |
创建对话。 |
方法
构造函数详细信息
Conversations(ConnectorClientContext)
方法详细信息
createConversation(ConversationParameters, RequestOptionsBase)
创建新的对话。 使用 a
- 机器人是创建聊天的机器人
- IsGroup 设置为 true(如果这不是直接消息(默认值为 false)
- 包含要包含在会话中的成员的数组
返回值为 ResourceResponse,其中包含适合在消息有效负载和 REST API URI 中使用的会话 ID。
大多数通道仅支持启动直接消息会话的机器人的语义。 如何执行此操作的示例为:
const resource = await connector.conversations.createConversation({
bot,
members: [{ id: 'user1' }]
});
await connector.conversations.sendToConversation(resource.Id, ... );
function createConversation(parameters: ConversationParameters, options?: RequestOptionsBase): Promise<Models.ConversationsCreateConversationResponse>
参数
- parameters
-
ConversationParameters
用于从 创建对话的参数
- options
-
RequestOptionsBase
返回
Promise<Models.ConversationsCreateConversationResponse>
Promise<Models.ConversationsCreateConversationResponse>
createConversation(ConversationParameters, RequestOptionsBase, ServiceCallback<ConversationResourceResponse>)
function createConversation(parameters: ConversationParameters, options: RequestOptionsBase, callback: ServiceCallback<ConversationResourceResponse>)
参数
- parameters
-
ConversationParameters
用于从 创建对话的参数
- options
-
RequestOptionsBase
可选参数
- callback
-
ServiceCallback<ConversationResourceResponse>
回调
createConversation(ConversationParameters, ServiceCallback<ConversationResourceResponse>)
function createConversation(parameters: ConversationParameters, callback: ServiceCallback<ConversationResourceResponse>)
参数
- parameters
-
ConversationParameters
用于从 创建对话的参数
- callback
-
ServiceCallback<ConversationResourceResponse>
回调
deleteActivity(string, string, RequestOptionsBase)
删除现有活动。 某些通道允许删除现有活动,如果成功,此方法将删除指定的活动。
function deleteActivity(conversationId: string, activityId: string, options?: RequestOptionsBase): Promise<RestResponse>
参数
- conversationId
-
string
对话 ID
- activityId
-
string
要删除的 activityId
- options
-
RequestOptionsBase
返回
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteActivity(string, string, RequestOptionsBase, ServiceCallback<void>)
function deleteActivity(conversationId: string, activityId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)
参数
- conversationId
-
string
对话 ID
- activityId
-
string
要删除的 activityId
- options
-
RequestOptionsBase
可选参数
- callback
-
ServiceCallback<void>
回调
deleteActivity(string, string, ServiceCallback<void>)
function deleteActivity(conversationId: string, activityId: string, callback: ServiceCallback<void>)
参数
- conversationId
-
string
对话 ID
- activityId
-
string
要删除的 activityId
- callback
-
ServiceCallback<void>
回调
deleteConversationMember(string, string, RequestOptionsBase)
从对话中删除成员。 此 REST API 采用 ConversationId 和 memberId(类型为字符串),并从会话中删除该成员。 如果该成员是对话的最后一个成员,则对话也将被删除。
function deleteConversationMember(conversationId: string, memberId: string, options?: RequestOptionsBase): Promise<RestResponse>
参数
- conversationId
-
string
对话 ID
- memberId
-
string
要从此对话中删除的成员的 ID
- options
-
RequestOptionsBase
返回
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteConversationMember(string, string, RequestOptionsBase, ServiceCallback<void>)
function deleteConversationMember(conversationId: string, memberId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)
参数
- conversationId
-
string
对话 ID
- memberId
-
string
要从此对话中删除的成员的 ID
- options
-
RequestOptionsBase
可选参数
- callback
-
ServiceCallback<void>
回调
deleteConversationMember(string, string, ServiceCallback<void>)
function deleteConversationMember(conversationId: string, memberId: string, callback: ServiceCallback<void>)
参数
- conversationId
-
string
对话 ID
- memberId
-
string
要从此对话中删除的成员的 ID
- callback
-
ServiceCallback<void>
回调
getActivityMembers(string, string, RequestOptionsBase)
枚举活动的成员。 此 REST API 采用 ConversationId 和 ActivityId,返回一个 ChannelAccount 对象数组,表示会话中特定活动的成员。
function getActivityMembers(conversationId: string, activityId: string, options?: RequestOptionsBase): Promise<Models.ConversationsGetActivityMembersResponse>
参数
- conversationId
-
string
对话 ID
- activityId
-
string
活动 ID
- options
-
RequestOptionsBase
返回
Promise<Models.ConversationsGetActivityMembersResponse>
Promise<Models.ConversationsGetActivityMembersResponse>
getActivityMembers(string, string, RequestOptionsBase, ServiceCallback<ChannelAccount[]>)
function getActivityMembers(conversationId: string, activityId: string, options: RequestOptionsBase, callback: ServiceCallback<ChannelAccount[]>)
参数
- conversationId
-
string
对话 ID
- activityId
-
string
活动 ID
- options
-
RequestOptionsBase
可选参数
- callback
-
ServiceCallback<ChannelAccount[]>
回调
getActivityMembers(string, string, ServiceCallback<ChannelAccount[]>)
function getActivityMembers(conversationId: string, activityId: string, callback: ServiceCallback<ChannelAccount[]>)
参数
- conversationId
-
string
对话 ID
- activityId
-
string
活动 ID
- callback
-
ServiceCallback<ChannelAccount[]>
回调
getConversationMember(string, string, RequestOptionsBase | ServiceCallback<ChannelAccount[]>, ServiceCallback<ChannelAccount[]>)
function getConversationMember(conversationId: string, memberId: string, options?: RequestOptionsBase | ServiceCallback<ChannelAccount[]>, callback?: ServiceCallback<ChannelAccount[]>): Promise<Models.ConversationsGetConversationMemberResponse>
参数
- conversationId
-
string
对话 ID
- memberId
-
string
用户的 MemberId
- options
-
RequestOptionsBase | ServiceCallback<ChannelAccount[]>
可选参数
- callback
-
ServiceCallback<ChannelAccount[]>
回调
返回
Promise<Models.ConversationsGetConversationMemberResponse>
getConversationMembers(string, RequestOptionsBase)
枚举会话的成员。 此 REST API 采用 ConversationId 并返回一组代表聊天成员的 ChannelAccount 对象。
function getConversationMembers(conversationId: string, options?: RequestOptionsBase): Promise<Models.ConversationsGetConversationMembersResponse>
参数
- conversationId
-
string
对话 ID
- options
-
RequestOptionsBase
返回
Promise<Models.ConversationsGetConversationMembersResponse>
Promise<Models.ConversationsGetConversationMembersResponse>
getConversationMembers(string, RequestOptionsBase, ServiceCallback<ChannelAccount[]>)
function getConversationMembers(conversationId: string, options: RequestOptionsBase, callback: ServiceCallback<ChannelAccount[]>)
参数
- conversationId
-
string
对话 ID
- options
-
RequestOptionsBase
可选参数
- callback
-
ServiceCallback<ChannelAccount[]>
回调
getConversationMembers(string, ServiceCallback<ChannelAccount[]>)
function getConversationMembers(conversationId: string, callback: ServiceCallback<ChannelAccount[]>)
参数
- conversationId
-
string
对话 ID
- callback
-
ServiceCallback<ChannelAccount[]>
回调
getConversationPagedMembers(string, ConversationsGetConversationPagedMembersOptionalParams)
枚举对话的成员一次一页。 此 REST API 采用 ConversationId。 可以选择提供 pageSize 和/或 continuationToken。 它返回一个 PagedMembersResult,其中包含一个 ChannelAccounts 数组,表示会话的成员和可用于获取更多值的延续标记。
每个调用都会返回 ChannelAccounts 记录的一页。 页面中的记录数可能因通道和调用而异。 pageSize 参数可用作建议。 如果没有其他结果,响应将不包含延续标记。 如果对话中没有成员,则成员在响应中为空或不存在。
对具有先前请求的延续令牌的请求的响应可能很少返回来自上一个请求的成员。
function getConversationPagedMembers(conversationId: string, options?: ConversationsGetConversationPagedMembersOptionalParams): Promise<Models.ConversationsGetConversationPagedMembersResponse>
参数
- conversationId
-
string
对话 ID
返回
Promise<Models.ConversationsGetConversationPagedMembersResponse>
Promise<Models.ConversationsGetConversationPagedMembersResponse>
getConversationPagedMembers(string, ConversationsGetConversationPagedMembersOptionalParams, ServiceCallback<PagedMembersResult>)
function getConversationPagedMembers(conversationId: string, options: ConversationsGetConversationPagedMembersOptionalParams, callback: ServiceCallback<PagedMembersResult>)
参数
- conversationId
-
string
对话 ID
- callback
-
ServiceCallback<PagedMembersResult>
回调
getConversationPagedMembers(string, ServiceCallback<PagedMembersResult>)
function getConversationPagedMembers(conversationId: string, callback: ServiceCallback<PagedMembersResult>)
参数
- conversationId
-
string
对话 ID
- callback
-
ServiceCallback<PagedMembersResult>
回调
getConversations(ConversationsGetConversationsOptionalParams)
列出此机器人参与的对话。 使用跳过令牌从此方法获取
返回值为 ConversationsResult,其中包含 ConversationMembers 数组和跳过令牌。 如果跳过令牌不为空,则返回其他值。 使用返回的令牌再次调用此方法以获取更多值。
每个 ConversationMembers 对象都包含聊天的 ID,以及描述聊天成员的 ChannelAccounts 数组。
function getConversations(options?: ConversationsGetConversationsOptionalParams): Promise<Models.ConversationsGetConversationsResponse>
参数
返回
Promise<Models.ConversationsGetConversationsResponse>
Promise<Models.ConversationsGetConversationsResponse>
getConversations(ConversationsGetConversationsOptionalParams, ServiceCallback<ConversationsResult>)
function getConversations(options: ConversationsGetConversationsOptionalParams, callback: ServiceCallback<ConversationsResult>)
参数
可选参数
- callback
-
ServiceCallback<ConversationsResult>
回调
getConversations(ServiceCallback<ConversationsResult>)
function getConversations(callback: ServiceCallback<ConversationsResult>)
参数
- callback
-
ServiceCallback<ConversationsResult>
回调
replyToActivity(string, string, Partial<Activity>, RequestOptionsBase)
此方法允许你回复活动。 这与 SendToConversation()略有不同。
- SendToConversation(conversationId) - 将根据通道的时间戳或语义将活动追加到会话末尾。
- ReplyToActivity(conversationId,ActivityId) - 如果通道支持该活动,则将该活动添加为另一个活动的回复。 如果通道不支持嵌套回复,ReplyToActivity 会回退到 SendToConversation。
在答复对话中的特定活动时使用 ReplyToActivity。
在所有其他情况下使用 SendToConversation。
function replyToActivity(conversationId: string, activityId: string, activity: Partial<Activity>, options?: RequestOptionsBase): Promise<Models.ConversationsReplyToActivityResponse>
参数
- conversationId
-
string
对话 ID
- activityId
-
string
reply 为 activityId (OPTIONAL)
- activity
-
Partial<Activity>
要发送的活动
- options
-
RequestOptionsBase
返回
Promise<Models.ConversationsReplyToActivityResponse>
Promise<Models.ConversationsReplyToActivityResponse>
replyToActivity(string, string, Partial<Activity>, RequestOptionsBase, ServiceCallback<ResourceResponse>)
function replyToActivity(conversationId: string, activityId: string, activity: Partial<Activity>, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)
参数
- conversationId
-
string
对话 ID
- activityId
-
string
reply 为 activityId (OPTIONAL)
- activity
-
Partial<Activity>
要发送的活动
- options
-
RequestOptionsBase
可选参数
- callback
-
ServiceCallback<ResourceResponse>
回调
replyToActivity(string, string, Partial<Activity>, ServiceCallback<ResourceResponse>)
function replyToActivity(conversationId: string, activityId: string, activity: Partial<Activity>, callback: ServiceCallback<ResourceResponse>)
参数
- conversationId
-
string
对话 ID
- activityId
-
string
reply 为 activityId (OPTIONAL)
- activity
-
Partial<Activity>
要发送的活动
- callback
-
ServiceCallback<ResourceResponse>
回调
sendConversationHistory(string, Transcript, RequestOptionsBase)
此方法允许你将历史活动上传到对话。 发送方必须确保历史活动具有唯一 ID 和适当的时间戳。 客户端使用 ID 来处理重复活动,客户端使用时间戳以正确的顺序呈现活动。
function sendConversationHistory(conversationId: string, history: Transcript, options?: RequestOptionsBase): Promise<Models.ConversationsSendConversationHistoryResponse>
参数
- conversationId
-
string
对话 ID
- history
-
Transcript
历史活动
- options
-
RequestOptionsBase
返回
Promise<Models.ConversationsSendConversationHistoryResponse>
Promise<Models.ConversationsSendConversationHistoryResponse>
sendConversationHistory(string, Transcript, RequestOptionsBase, ServiceCallback<ResourceResponse>)
function sendConversationHistory(conversationId: string, history: Transcript, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)
参数
- conversationId
-
string
对话 ID
- history
-
Transcript
历史活动
- options
-
RequestOptionsBase
可选参数
- callback
-
ServiceCallback<ResourceResponse>
回调
sendConversationHistory(string, Transcript, ServiceCallback<ResourceResponse>)
function sendConversationHistory(conversationId: string, history: Transcript, callback: ServiceCallback<ResourceResponse>)
参数
- conversationId
-
string
对话 ID
- history
-
Transcript
历史活动
- callback
-
ServiceCallback<ResourceResponse>
回调
sendToConversation(string, Partial<Activity>, RequestOptionsBase)
此方法允许将活动发送到会话的末尾。 这与 ReplyToActivity 略有不同。
- SendToConversation(conversationId) - 将根据通道的时间戳或语义将活动追加到会话末尾。
- ReplyToActivity(conversationId,ActivityId) - 如果通道支持该活动,则将该活动添加为另一个活动的回复。 如果通道不支持嵌套回复,ReplyToActivity 会回退到 SendToConversation。
在答复对话中的特定活动时使用 ReplyToActivity。
在所有其他情况下使用 SendToConversation。
function sendToConversation(conversationId: string, activity: Partial<Activity>, options?: RequestOptionsBase): Promise<Models.ConversationsSendToConversationResponse>
参数
- conversationId
-
string
对话 ID
- activity
-
Partial<Activity>
要发送的活动
- options
-
RequestOptionsBase
返回
Promise<Models.ConversationsSendToConversationResponse>
Promise<Models.ConversationsSendToConversationResponse>
sendToConversation(string, Partial<Activity>, RequestOptionsBase, ServiceCallback<ResourceResponse>)
function sendToConversation(conversationId: string, activity: Partial<Activity>, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)
参数
- conversationId
-
string
对话 ID
- activity
-
Partial<Activity>
要发送的活动
- options
-
RequestOptionsBase
可选参数
- callback
-
ServiceCallback<ResourceResponse>
回调
sendToConversation(string, Partial<Activity>, ServiceCallback<ResourceResponse>)
function sendToConversation(conversationId: string, activity: Partial<Activity>, callback: ServiceCallback<ResourceResponse>)
参数
- conversationId
-
string
对话 ID
- activity
-
Partial<Activity>
要发送的活动
- callback
-
ServiceCallback<ResourceResponse>
回调
updateActivity(string, string, Partial<Activity>, RequestOptionsBase)
编辑现有活动。 某些通道允许编辑现有活动以反映机器人聊天的新状态。
例如,在有人单击“批准”按钮后,可以删除按钮。
function updateActivity(conversationId: string, activityId: string, activity: Partial<Activity>, options?: RequestOptionsBase): Promise<Models.ConversationsUpdateActivityResponse>
参数
- conversationId
-
string
对话 ID
- activityId
-
string
要更新的 activityId
- activity
-
Partial<Activity>
替换活动
- options
-
RequestOptionsBase
返回
Promise<Models.ConversationsUpdateActivityResponse>
Promise<Models.ConversationsUpdateActivityResponse>
updateActivity(string, string, Partial<Activity>, RequestOptionsBase, ServiceCallback<ResourceResponse>)
function updateActivity(conversationId: string, activityId: string, activity: Partial<Activity>, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)
参数
- conversationId
-
string
对话 ID
- activityId
-
string
要更新的 activityId
- activity
-
Partial<Activity>
替换活动
- options
-
RequestOptionsBase
可选参数
- callback
-
ServiceCallback<ResourceResponse>
回调
updateActivity(string, string, Partial<Activity>, ServiceCallback<ResourceResponse>)
function updateActivity(conversationId: string, activityId: string, activity: Partial<Activity>, callback: ServiceCallback<ResourceResponse>)
参数
- conversationId
-
string
对话 ID
- activityId
-
string
要更新的 activityId
- activity
-
Partial<Activity>
替换活动
- callback
-
ServiceCallback<ResourceResponse>
回调
uploadAttachment(string, AttachmentData, RequestOptionsBase)
将附件直接上传到通道的 Blob 存储中。 这非常有用,因为它允许你在处理企业时将数据存储在合规的存储中。
响应是一个 ResourceResponse,其中包含适用于附件 API 的 AttachmentId。
function uploadAttachment(conversationId: string, attachmentUpload: AttachmentData, options?: RequestOptionsBase): Promise<Models.ConversationsUploadAttachmentResponse>
参数
- conversationId
-
string
对话 ID
- attachmentUpload
-
AttachmentData
附件数据
- options
-
RequestOptionsBase
返回
Promise<Models.ConversationsUploadAttachmentResponse>
Promise<Models.ConversationsUploadAttachmentResponse>
uploadAttachment(string, AttachmentData, RequestOptionsBase, ServiceCallback<ResourceResponse>)
function uploadAttachment(conversationId: string, attachmentUpload: AttachmentData, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)
参数
- conversationId
-
string
对话 ID
- attachmentUpload
-
AttachmentData
附件数据
- options
-
RequestOptionsBase
可选参数
- callback
-
ServiceCallback<ResourceResponse>
回调
uploadAttachment(string, AttachmentData, ServiceCallback<ResourceResponse>)
function uploadAttachment(conversationId: string, attachmentUpload: AttachmentData, callback: ServiceCallback<ResourceResponse>)
参数
- conversationId
-
string
对话 ID
- attachmentUpload
-
AttachmentData
附件数据
- callback
-
ServiceCallback<ResourceResponse>
回调