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)

依標識符擷取交談的單一成員。

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 至此方法時,Bot 是建立交談 IsGroup 的 Bot,如果這不是直接訊息 (預設值為 false) 成員數位,則會連續您想要在交談中的成員。 傳回值是 ResourceResponse,其中包含適合用於訊息承載和 REST API URI 的交談標識符。 大部分通道只支援 Bot 起始直接訊息交談的語意。 如何做到這一點的範例是:''' var resource = await connector.conversations.CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount(“user1”) } ; await connect。Conversations.SendToConversation(resource.識別碼,新活動() ...;```

參數:

parameters - 要從中建立交談的參數

傳回:

ConversationResourceResponse 物件的可觀察專案

deleteActivity

public abstract CompletableFuture deleteActivity(String conversationId, String activityId)

DeleteActivity。 刪除現有的活動。 某些通道可讓您刪除現有的活動,如果成功,這個方法將會移除指定的活動。

參數:

conversationId - 交談標識碼
activityId - 要刪除的 activityId

傳回:

如果成功,則為 ServiceResponse<T> 物件。

deleteConversationMember

public abstract CompletableFuture deleteConversationMember(String conversationId, String memberId)

DeleteConversationMember。 從交談中刪除成員。 此 REST API 會採用 ConversationId 和 memberId(類型為 string),並從交談中移除該成員。 如果該成員是交談的最後一個成員,也會刪除交談。

參數:

conversationId - 交談標識碼
memberId - 要從此交談中刪除的成員標識碼

傳回:

如果成功,則為 ServiceResponse<T> 物件。

getActivityMembers

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

GetActivityMembers。 列舉活動的成員。 此 REST API 會採用 ConversationId 和 ActivityId,傳回 ChannelAccount 物件的陣列,代表交談中特定活動的成員。

參數:

conversationId - 交談標識碼
activityId - 活動標識碼

傳回:

可觀察至 List<ChannelAccount> 物件

getConversationMember

public abstract CompletableFuture getConversationMember(String userId, String conversationId)

依標識符擷取交談的單一成員。

參數:

userId - 用戶標識碼。
conversationId - 交談標識碼。

傳回:

使用者的 ChannelAccount。

getConversationMembers

public abstract CompletableFuture> getConversationMembers(String conversationId)

GetConversationMembers。 列舉交匯的成員。 此 REST API 會取得 ConversationId,並傳回代表交談成員的 ChannelAccount 物件陣列。

參數:

conversationId - 交談標識碼

傳回:

可觀察至 List<ChannelAccount> 物件

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId)

一次列舉一頁交談的成員。 此 REST API 會採用 ConversationId。 您可以選擇提供 pageSize 和/或 continuationToken。 它會傳回 PagedMembersResult,其中包含 ChannelAccounts 陣列,代表交談的成員和可用來取得更多值的接續令牌。 每個呼叫都會傳回 ChannelAccounts 記錄的一頁。 頁面中的記錄數目可能會因通道和呼叫而有所不同。 如果沒有其他結果,回應將不會包含接續令牌。 如果交談中沒有任何成員,則成員在回應中將會是空的或不存在的。 對先前要求具有接續令牌的要求回應,可能很少會從先前的要求傳回成員。

參數:

conversationId - 交談標識碼

傳回:

如果成功,則為 PagedMembersResult 物件。

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId, String continuationToken)

一次列舉一頁交談的成員。 此 REST API 會採用 ConversationId。 您可以選擇提供 pageSize 和/或 continuationToken。 它會傳回 PagedMembersResult,其中包含 ChannelAccounts 陣列,代表交談的成員和可用來取得更多值的接續令牌。 每個呼叫都會傳回 ChannelAccounts 記錄的一頁。 頁面中的記錄數目可能會因通道和呼叫而有所不同。 如果沒有其他結果,回應將不會包含接續令牌。 如果交談中沒有任何成員,則成員在回應中將會是空的或不存在的。 對先前要求具有接續令牌的要求回應,可能很少會從先前的要求傳回成員。

參數:

conversationId - 交談標識碼
continuationToken - 上一個呼叫中的 continuationToken。

傳回:

如果成功,則為 PagedMembersResult 物件。

getConversations

public abstract CompletableFuture getConversations()

GetConversations。 列出此 Bot 參與的交談。 使用 skip Token 從這個方法取得 傳回值是 ConversationsResult,其中包含 ConversationMembers 和 skip Token 的陣列。 如果略過令牌不是空的,則會傳回其他值。 使用傳回的令牌再次呼叫這個方法,以取得更多值。 每個 ConversationMembers 物件都包含交談的標識碼,以及描述交談成員的 ChannelAccounts 陣列。

傳回:

ConversationsResult 物件的可觀察物件

getConversations

public abstract CompletableFuture getConversations(String continuationToken)

GetConversations。 列出此 Bot 參與的交談。 使用 skip Token 從這個方法取得 傳回值是 ConversationsResult,其中包含 ConversationMembers 和 skip Token 的陣列。 如果略過令牌不是空的,則會傳回其他值。 使用傳回的令牌再次呼叫這個方法,以取得更多值。 每個 ConversationMembers 物件都包含交談的標識碼,以及描述交談成員的 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 - 交談標識碼
activityId - activityId 回復為 (選擇性)
activity - 要傳送的活動

傳回:

可觀察到 ResourceResponse 物件

sendConversationHistory

public abstract CompletableFuture sendConversationHistory(String conversationId, Transcript history)

這個方法可讓您將歷史活動上傳至交談。 傳送者必須確保歷史活動具有唯一標識碼和適當的時間戳。 用戶端會使用標識碼來處理重複的活動,而用戶端會使用時間戳,以正確的順序轉譯活動。

參數:

conversationId - 交談標識碼
history - 歷史活動

傳回:

如果成功,則為 ResourceResponse 物件。

sendToConversation

public default CompletableFuture sendToConversation(Activity activity)

SendToConversation。 這個方法可讓您將活動傳送至交談結尾。 這與 ReplyToActivity() 稍有不同。 sendToConverstion(activity) - 會根據通道的時間戳或語意,使用 Conversation 標識符的 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 - 交談標識碼
activity - 要傳送的活動

傳回:

可觀察到 ResourceResponse 物件

updateActivity

public default CompletableFuture updateActivity(Activity activity)

UpdateActivity。 編輯現有的活動。 某些通道可讓您編輯現有的活動,以反映 Bot 交談的新狀態。 例如,您可以在某人按兩下 [核准] 按鈕之後移除按鈕。

參數:

activity - 取代活動

傳回:

可觀察到 ResourceResponse 物件

updateActivity

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

UpdateActivity。 編輯現有的活動。 某些通道可讓您編輯現有的活動,以反映 Bot 交談的新狀態。 例如,您可以在某人按兩下 [核准] 按鈕之後移除按鈕。

參數:

conversationId - 交談標識碼
activityId - 要更新的 activityId
activity - 取代活動

傳回:

可觀察到 ResourceResponse 物件

uploadAttachment

public abstract CompletableFuture uploadAttachment(String conversationId, AttachmentData attachmentUpload)

UploadAttachment。 將附件直接上傳至通道的 Blob 記憶體。 這非常有用,因為它可讓您在處理企業時將數據儲存在相容的存放區中。 回應是 ResourceResponse,其中包含適合用於附件 API 的 AttachmentId。

參數:

conversationId - 交談標識碼
attachmentUpload - 附件數據

傳回:

可觀察到 ResourceResponse 物件

適用於