Conversations 接口

public interface Conversations

此类的实例提供对 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)

SendToConversation。

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

SendToConversation。

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, members = new ChannelAccount[] { new ChannelAccount (“user1”) } ) ; await connect。Conversations.SendToConversation (资源。Id, new Activity () ... ) ;```

Parameters:

parameters - 要从中创建会话的参数

Returns:

ConversationResourceResponse 对象的可观测值

deleteActivity

public abstract CompletableFuture deleteActivity(String conversationId, String activityId)

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

Parameters:

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

Returns:

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

deleteConversationMember

public abstract CompletableFuture deleteConversationMember(String conversationId, String memberId)

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

Parameters:

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

Returns:

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

getActivityMembers

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

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

Parameters:

conversationId - 会话 ID
activityId - 活动 ID

Returns:

List<ChannelAccount> 对象的可观测值

getConversationMember

public abstract CompletableFuture getConversationMember(String userId, String conversationId)

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

Parameters:

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

Returns:

用户的 ChannelAccount。

getConversationMembers

public abstract CompletableFuture<>> getConversationMembers(String conversationId)

GetConversationMembers。 枚举会议的成员。 此 REST API 采用 ConversationId 并返回表示会话成员的 ChannelAccount 对象的数组。

Parameters:

conversationId - 会话 ID

Returns:

List<ChannelAccount> 对象的可观测值

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId)

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

Parameters:

conversationId - 会话 ID

Returns:

PagedMembersResult 对象(如果成功)。

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId, String continuationToken)

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

Parameters:

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

Returns:

PagedMembersResult 对象(如果成功)。

getConversations

public abstract CompletableFuture getConversations()

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

Returns:

ConversationsResult 对象的可观测值

getConversations

public abstract CompletableFuture getConversations(String continuationToken)

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

Parameters:

continuationToken - 跳过或继续标记

Returns:

ConversationsResult 对象的可观测值

replyToActivity

public default CompletableFuture replyToActivity(Activity activity)

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

Parameters:

activity - 要发送的活动

Returns:

可观测到 ResourceResponse 对象的

replyToActivity

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

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

Parameters:

conversationId - 会话 ID
activityId - activityId 答复 (可选)
activity - 要发送的活动

Returns:

可观测到 ResourceResponse 对象的

sendConversationHistory

public abstract CompletableFuture sendConversationHistory(String conversationId, Transcript history)

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

Parameters:

conversationId - 会话 ID
history - 历史活动

Returns:

如果成功,则为 ResourceResponse 对象。

sendToConversation

public default CompletableFuture sendToConversation(Activity activity)

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

Parameters:

activity - 要发送的活动

Returns:

可观测到 ResourceResponse 对象的

sendToConversation

public abstract CompletableFuture sendToConversation(String conversationId, Activity activity)

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

Parameters:

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

Returns:

可观测到 ResourceResponse 对象的

updateActivity

public default CompletableFuture updateActivity(Activity activity)

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

Parameters:

activity - 替换活动

Returns:

可观测到 ResourceResponse 对象的

updateActivity

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

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

Parameters:

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

Returns:

可观测到 ResourceResponse 对象的

uploadAttachment

public abstract CompletableFuture uploadAttachment(String conversationId, AttachmentData attachmentUpload)

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

Parameters:

conversationId - 会话 ID
attachmentUpload - 附件数据

Returns:

可观测到 ResourceResponse 对象的

适用于