Conversations 接口

public interface Conversations

此类的实例提供对对话中定义的所有作的访问权限。

方法摘要

修饰符和类型 方法和描述
abstract java.util.concurrent.CompletableFuture<ConversationResourceResponse> createConversation(ConversationParameters parameters)

创建对话。

abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(String conversationId, String activityId)

删除活动。

abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteConversationMember(String conversationId, String memberId)

删除对话成员。

abstract java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> getActivityMembers(String conversationId, String activityId)

获取活动成员。

abstract java.util.concurrent.CompletableFuture<ChannelAccount> getConversationMember(String userId, String conversationId)

按 ID 检索会话的单个成员。

abstract java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> getConversationMembers(String conversationId)

获取对话成员。

abstract java.util.concurrent.CompletableFuture<PagedMembersResult> getConversationPagedMembers(String conversationId)

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

abstract java.util.concurrent.CompletableFuture<PagedMembersResult> getConversationPagedMembers(String conversationId, String continuationToken)

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

abstract java.util.concurrent.CompletableFuture<ConversationsResult> getConversations()

获取对话。

abstract java.util.concurrent.CompletableFuture<ConversationsResult> getConversations(String continuationToken)

获取对话。

default java.util.concurrent.CompletableFuture<ResourceResponse> replyToActivity(Activity activity)

回复ToActivity。

abstract java.util.concurrent.CompletableFuture<ResourceResponse> replyToActivity(String conversationId, String activityId, Activity activity)

回复ToActivity。

abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendConversationHistory(String conversationId, Transcript history)

此方法允许你将历史活动上传到对话。

default java.util.concurrent.CompletableFuture<ResourceResponse> sendToConversation(Activity activity)

发送ToConversation。

abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendToConversation(String conversationId, Activity activity)

发送ToConversation。

default java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(Activity activity)

更新活动。

abstract java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(String conversationId, String activityId, Activity activity)

更新活动。

abstract java.util.concurrent.CompletableFuture<ResourceResponse> uploadAttachment(String conversationId, AttachmentData attachmentUpload)

上传附件。

方法详细信息

createConversation

public abstract CompletableFuture createConversation(ConversationParameters parameters)

CreateConversation。 创建新的对话。 POST 到此方法时,机器人是创建聊天的机器人 IsGroup 设置为 true(如果这不是直接消息(默认值为 false)成员数组,而成员数组则使你希望位于会话中的成员。 返回值为 ResourceResponse,其中包含适合在消息有效负载和 REST API URI 中使用的会话 ID。 大多数通道仅支持启动直接消息会话的机器人的语义。 如何执行此作的示例包括:“'' var resource = await connector.conversations.CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount(”user1“) } ; await connect。Conversations.SendToConversation(资源)。ID,新活动() ...;```

参数:

parameters - 用于从 创建对话的参数

返回:

ConversationResourceResponse 对象的可观测对象

deleteActivity

public abstract CompletableFuture deleteActivity(String conversationId, String activityId)

DeleteActivity。 删除现有活动。 某些通道允许删除现有活动,如果成功,此方法将删除指定的活动。

参数:

conversationId - 对话 ID
activityId - 要删除的 activityId

返回:

如果成功,则为 ServiceResponse<T> 对象。

deleteConversationMember

public abstract CompletableFuture deleteConversationMember(String conversationId, String memberId)

DeleteConversationMember。 从对话中删除成员。 此 REST API 采用 ConversationId 和 memberId(类型为字符串),并从会话中删除该成员。 如果该成员是对话的最后一个成员,则对话也将被删除。

参数:

conversationId - 对话 ID
memberId - 要从此对话中删除的成员的 ID

返回:

如果成功,则为 ServiceResponse<T> 对象。

getActivityMembers

public abstract CompletableFuture> getActivityMembers(String conversationId, String activityId)

GetActivityMembers。 枚举活动的成员。 此 REST API 采用 ConversationId 和 ActivityId,返回一个 ChannelAccount 对象数组,表示会话中特定活动的成员。

参数:

conversationId - 对话 ID
activityId - 活动 ID

返回:

List<ChannelAccount> 对象的可观测对象

getConversationMember

public abstract CompletableFuture getConversationMember(String userId, String conversationId)

按 ID 检索会话的单个成员。

参数:

userId - 用户 ID。
conversationId - 会话 ID。

返回:

用户的 ChannelAccount。

getConversationMembers

public abstract CompletableFuture> getConversationMembers(String conversationId)

GetConversationMembers。 枚举串联的成员。 此 REST API 采用 ConversationId 并返回一组代表聊天成员的 ChannelAccount 对象。

参数:

conversationId - 对话 ID

返回:

List<ChannelAccount> 对象的可观测对象

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId)

枚举对话的成员一次一页。 此 REST API 采用 ConversationId。 可以选择提供 pageSize 和/或 continuationToken。 它返回一个 PagedMembersResult,其中包含一个 ChannelAccounts 数组,表示会话的成员和可用于获取更多值的延续标记。 每个调用都会返回 ChannelAccounts 记录的一页。 页面中的记录数可能因通道和调用而异。 如果没有其他结果,响应将不包含延续标记。 如果对话中没有成员,则成员在响应中为空或不存在。 对具有先前请求的延续令牌的请求的响应可能很少返回来自上一个请求的成员。

参数:

conversationId - 对话 ID

返回:

如果成功,则为 PagedMembersResult 对象。

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId, String continuationToken)

枚举对话的成员一次一页。 此 REST API 采用 ConversationId。 可以选择提供 pageSize 和/或 continuationToken。 它返回一个 PagedMembersResult,其中包含一个 ChannelAccounts 数组,表示会话的成员和可用于获取更多值的延续标记。 每个调用都会返回 ChannelAccounts 记录的一页。 页面中的记录数可能因通道和调用而异。 如果没有其他结果,响应将不包含延续标记。 如果对话中没有成员,则成员在响应中为空或不存在。 对具有先前请求的延续令牌的请求的响应可能很少返回来自上一个请求的成员。

参数:

conversationId - 对话 ID
continuationToken - 上一次调用中的 continuationToken。

返回:

如果成功,则为 PagedMembersResult 对象。

getConversations

public abstract CompletableFuture getConversations()

GetConversations。 列出此机器人参与的对话。 使用跳过标记从此方法获取 返回值为 ConversationsResult,其中包含 ConversationMembers 数组和跳过令牌。 如果跳过令牌不为空,则返回其他值。 使用返回的令牌再次调用此方法以获取更多值。 每个 ConversationMembers 对象都包含聊天的 ID,以及描述聊天成员的 ChannelAccounts 数组。

返回:

ConversationsResult 对象的可观测对象

getConversations

public abstract CompletableFuture getConversations(String continuationToken)

GetConversations。 列出此机器人参与的对话。 使用跳过标记从此方法获取 返回值为 ConversationsResult,其中包含 ConversationMembers 数组和跳过令牌。 如果跳过令牌不为空,则返回其他值。 使用返回的令牌再次调用此方法以获取更多值。 每个 ConversationMembers 对象都包含聊天的 ID,以及描述聊天成员的 ChannelAccounts 数组。

参数:

continuationToken - 跳过或继续标记

返回:

ConversationsResult 对象的可观测对象

replyToActivity

public default CompletableFuture replyToActivity(Activity activity)

ReplyToActivity。 此方法允许你回复活动。 这与 SendToConversation()略有不同。 SendToConversation(conversationId) - 将根据通道的时间戳或语义将活动追加到会话末尾。 ReplyToActivity(conversationId,ActivityId) - 如果通道支持该活动,则将该活动添加为另一个活动的回复。 如果通道不支持嵌套回复,ReplyToActivity 会回退到 SendToConversation。 在答复对话中的特定活动时使用 ReplyToActivity。 在所有其他情况下使用 SendToConversation。

参数:

activity - 要发送的活动

返回:

ResourceResponse 对象的可观测对象

replyToActivity

public abstract CompletableFuture replyToActivity(String conversationId, String activityId, Activity activity)

ReplyToActivity。 此方法允许你回复活动。 这与 SendToConversation()略有不同。 SendToConversation(conversationId) - 将根据通道的时间戳或语义将活动追加到会话末尾。 ReplyToActivity(conversationId,ActivityId) - 如果通道支持该活动,则将该活动添加为另一个活动的回复。 如果通道不支持嵌套回复,ReplyToActivity 会回退到 SendToConversation。 在答复对话中的特定活动时使用 ReplyToActivity。 在所有其他情况下使用 SendToConversation。

参数:

conversationId - 对话 ID
activityId - reply 为 activityId (OPTIONAL)
activity - 要发送的活动

返回:

ResourceResponse 对象的可观测对象

sendConversationHistory

public abstract CompletableFuture sendConversationHistory(String conversationId, Transcript history)

此方法允许你将历史活动上传到对话。 发送方必须确保历史活动具有唯一 ID 和适当的时间戳。 客户端使用 ID 来处理重复活动,客户端使用时间戳以正确的顺序呈现活动。

参数:

conversationId - 对话 ID
history - 历史活动

返回:

如果成功,则为 ResourceResponse 对象。

sendToConversation

public default CompletableFuture sendToConversation(Activity activity)

SendToConversation。 此方法允许将活动发送到会话的末尾。 这与 ReplyToActivity 略有不同。 sendToConverstion(activity) - 使用 Conversation ID 的 Activity.getConversation.getId,根据通道的时间戳或语义将活动追加到会话末尾。 replyToActivity(conversationId,ActivityId) - 如果通道支持该活动,则添加活动作为另一个活动的回复。 如果通道不支持嵌套回复,ReplyToActivity 会回退到 SendToConversation。 在答复对话中的特定活动时使用 ReplyToActivity。 在所有其他情况下使用 SendToConversation。

参数:

activity - 要发送的活动

返回:

ResourceResponse 对象的可观测对象

sendToConversation

public abstract CompletableFuture sendToConversation(String conversationId, Activity activity)

SendToConversation。 此方法允许将活动发送到会话的末尾。 这与 ReplyToActivity 略有不同。 SendToConverstion(conversationId) - 将根据通道的时间戳或语义将活动追加到会话的末尾。 ReplyToActivity(conversationId,ActivityId) - 如果通道支持该活动,则将该活动添加为另一个活动的回复。 如果通道不支持嵌套回复,ReplyToActivity 会回退到 SendToConversation。 在答复对话中的特定活动时使用 ReplyToActivity。 在所有其他情况下使用 SendToConversation。

参数:

conversationId - 对话 ID
activity - 要发送的活动

返回:

ResourceResponse 对象的可观测对象

updateActivity

public default CompletableFuture updateActivity(Activity activity)

UpdateActivity。 编辑现有活动。 某些通道允许编辑现有活动以反映机器人聊天的新状态。 例如,在有人单击“批准”按钮后,可以删除按钮。

参数:

activity - 替换活动

返回:

ResourceResponse 对象的可观测对象

updateActivity

public abstract CompletableFuture updateActivity(String conversationId, String activityId, Activity activity)

UpdateActivity。 编辑现有活动。 某些通道允许编辑现有活动以反映机器人聊天的新状态。 例如,在有人单击“批准”按钮后,可以删除按钮。

参数:

conversationId - 对话 ID
activityId - 要更新的 activityId
activity - 替换活动

返回:

ResourceResponse 对象的可观测对象

uploadAttachment

public abstract CompletableFuture uploadAttachment(String conversationId, AttachmentData attachmentUpload)

UploadAttachment。 将附件直接上传到通道的 Blob 存储中。 这非常有用,因为它允许你在处理企业时将数据存储在合规的存储中。 响应是一个 ResourceResponse,其中包含适用于附件 API 的 AttachmentId。

参数:

conversationId - 对话 ID
attachmentUpload - 附件数据

返回:

ResourceResponse 对象的可观测对象

适用于