TurnContext 介面

  • 參考
套件:
com.microsoft.bot.builder
Maven 成品:
com.microsoft.bot:bot-builder:4.14.3

public interface TurnContext

提供 Bot 回合的內容。

內容提供處理傳入活動所需的資訊。 內容物件是由 BotAdapter 所建立，並保存回合長度。

Bot Middleware

欄位摘要

修飾詞與類型 欄位與描述
static final java.lang.String STATE_TURN_LOCALE

方法摘要

修飾詞與類型 方法與描述
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(ConversationReference conversationReference)

刪除現有的活動。
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(String activityId)

刪除現有的活動。
abstract Activity getActivity()

取得 Bot 回合的活動。
abstract BotAdapter getAdapter()

取得建立此內容物件的 Bot 配接器。
abstract java.lang.String getLocale()

取得這個內容對象的地區設定。
abstract boolean getResponded()

取得值，指出目前回合是否至少傳送一個回應。
abstract TurnContextStateCollection getTurnState()

取得使用回合存留期之內容物件快取的值集合。
abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

新增刪除活動作業的回應處理程式。
abstract TurnContext onSendActivities(SendActivitiesHandler handler)

新增傳送活動作業的回應處理程式。
abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

新增更新活動作業的回應處理程式。
default java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(Activity[] activities)

用來傳送 Activity 陣列的 Helper 方法。
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(List<Activity> activities)

將活動清單傳送給傳入活動的傳送者。
abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(Activity activity)

將活動傳送給傳入活動的傳送者。
abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend)

將訊息活動傳送給傳入活動的傳送者。
abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak)

將訊息活動傳送給傳入活動的傳送者。
abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak, InputHints inputHint)

將訊息活動傳送給傳入活動的傳送者。
default java.util.concurrent.CompletableFuture<java.lang.Void> sendActivityBlind(Activity activity)

將活動傳送給傳入活動的傳送者，而不傳回資源回應。
abstract void setLocale(String withLocale)

在此內容物件上設定地區設定。
static java.util.concurrent.CompletableFuture<ResourceResponse> traceActivity(TurnContext turnContext, String name)
static java.util.concurrent.CompletableFuture<ResourceResponse> traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label)

將追蹤活動傳送至 BotAdapter 以供記錄之用。
abstract java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(Activity withActivity)

取代現有的活動。

欄位詳細資料

STATE_TURN_LOCALE

public static final String STATE_TURN_LOCALE

方法詳細資料

deleteActivity

public abstract CompletableFuture deleteActivity(ConversationReference conversationReference)

刪除現有的活動。

參數:

conversationReference - 包含要刪除之活動的交談。

傳回:

工作，表示要執行的工作佇列。 交談參考的 ConversationReference#getActivityId 指出要刪除之交談中的活動。

deleteActivity

public abstract CompletableFuture deleteActivity(String activityId)

刪除現有的活動。

參數:

activityId - 要刪除之活動的識別碼。

傳回:

工作，表示要執行的工作佇列。

getActivity

public abstract Activity getActivity()

取得 Bot 回合的活動。

傳回:

這個 Bot 回合的活動。

getAdapter

public abstract BotAdapter getAdapter()

取得建立此內容物件的 Bot 配接器。

傳回:

建立此內容物件的 Bot 配接器。

getLocale

public abstract String getLocale()

取得這個內容對象的地區設定。

傳回:

此內容物件上地區設定的字串。

getResponded

public abstract boolean getResponded()

取得值，指出目前回合是否至少傳送一個回應。

傳回:

如果已針對目前回合至少傳送一個回應，true;否則，false。

getTurnState

public abstract TurnContextStateCollection getTurnState()

取得使用回合存留期之內容物件快取的值集合。

傳回:

在此內容對象上註冊的服務集合。

onDeleteActivity

public abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

新增刪除活動作業的回應處理程式。

呼叫內容 deleteActivity(String activityId) 時，配接器會依新增至內容對象的順序呼叫已註冊的處理程式。

參數:

handler - 要加入至內容對象的處理程式。

傳回:

更新的內容物件。

onSendActivities

public abstract TurnContext onSendActivities(SendActivitiesHandler handler)

新增傳送活動作業的回應處理程式。

呼叫內容 sendActivity(Activity activity) 或 sendActivities(List<Activity> activities) 方法時，配接器會依新增至內容對象的順序呼叫已註冊的處理程式。

參數:

handler - 要加入至內容對象的處理程式。

傳回:

更新的內容物件。

onUpdateActivity

public abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

新增更新活動作業的回應處理程式。

呼叫內容 updateActivity(Activity withActivity) 時，配接器會依新增至內容對象的順序呼叫已註冊的處理程式。

參數:

handler - 要加入至內容對象的處理程式。

傳回:

更新的內容物件。

sendActivities

public default CompletableFuture sendActivities(Activity[] activities)

用來傳送 Activity 陣列的 Helper 方法。 這會呼叫 sendActivities(List<Activity> activities)。

參數:

activities - 活動的陣列。

傳回:

工作，表示要執行的工作佇列。

sendActivities

public abstract CompletableFuture sendActivities(List activities)

將活動清單傳送給傳入活動的傳送者。

如果成功傳送活動，工作結果會包含 ResourceResponse 對象的陣列，其中包含指派給活動的接收通道標識碼。

參數:

activities - 要傳送的活動。

傳回:

工作，表示要執行的工作佇列。

sendActivity

public abstract CompletableFuture sendActivity(Activity activity)

將活動傳送給傳入活動的傳送者。

參數:

activity - 要傳送的活動。

傳回:

工作，表示要執行的工作佇列。 如果成功傳送活動，工作結果會包含 ResourceResponse 物件，其中包含指派給活動的接收通道標識碼。

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend)

將訊息活動傳送給傳入活動的傳送者。

如果成功傳送活動，工作結果會包含 ResourceResponse 物件，其中包含指派給活動的接收通道標識碼。

如需對 textReplyToSend內容施加的限制，請參閱通道的檔。

參數:

textReplyToSend - 要傳送之訊息的文字。

傳回:

工作，表示要執行的工作佇列。

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak)

將訊息活動傳送給傳入活動的傳送者。

如果成功傳送活動，工作結果會包含 ResourceResponse 物件，其中包含指派給活動的接收通道標識碼。

如需對 textReplyToSend內容施加的限制，請參閱通道的檔。

若要控制 Bot 語音的各種特性，例如語音、速率、音量、發音和音調，請以語音合成標記語言 （SSML） 格式指定 speak。

參數:

textReplyToSend - 要傳送之訊息的文字。
speak - 選擇性的文字，由 Bot 在啟用語音功能的通道上說出。

傳回:

工作，表示要執行的工作佇列。

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak, InputHints inputHint)

將訊息活動傳送給傳入活動的傳送者。

如果成功傳送活動，工作結果會包含 ResourceResponse 物件，其中包含指派給活動的接收通道標識碼。

如需對 textReplyToSend內容施加的限制，請參閱通道的檔。

若要控制 Bot 語音的各種特性，例如語音、速率、音量、發音和音調，請以語音合成標記語言 （SSML） 格式指定 speak。

參數:

textReplyToSend - 要傳送之訊息的文字。
speak - 選擇性的文字，由 Bot 在啟用語音功能的通道上說出。
inputHint - 選擇性表示 Bot 在訊息傳遞至客戶端之後是否接受、預期或忽略使用者輸入。 其中一個：「acceptingInput」、“ignoringInput” 或 “expectingInput”。 預設值為 「acceptingInput」。。

傳回:

工作，表示要執行的工作佇列。

sendActivityBlind

public default CompletableFuture sendActivityBlind(Activity activity)

將活動傳送給傳入活動的傳送者，而不傳回 ResourceResponse。

參數:

activity - 要傳送的活動。

傳回:

工作，表示要執行的工作佇列。

setLocale

public abstract void setLocale(String withLocale)

在此內容物件上設定地區設定。

參數:

withLocale - 此內容物件上地區設定的字串。

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name)

參數:

turnContext - turnContext。
name - 活動的名稱。

傳回:

ResourceReponse 的未來。

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label)

將追蹤活動傳送至 BotAdapter 以供記錄之用。

參數:

turnContext - 目前回合的內容。
name - 要指派給活動 Activity#getName 屬性的值。
value - 要指派給活動 Activity#getValue 屬性的值。
valueType - 要指派給活動 Activity#getValueType 屬性的值。
label - 要指派給活動 Activity#getLabel 屬性的值。

傳回:

工作，表示要執行的工作佇列。 如果配接器裝載於模擬器中，工作結果會包含具有原始追蹤活動標識碼的 ResourceResponse 物件;否則，它會包含 ResourceResponse 物件，其中包含指派給活動的接收通道標識碼。

updateActivity

public abstract CompletableFuture updateActivity(Activity withActivity)

取代現有的活動。

如果成功傳送活動，工作結果會包含 ResourceResponse 物件，其中包含指派給活動的接收通道標識碼。

呼叫此專案之前，請將取代活動的標識碼設定為要取代之活動的標識碼。

參數:

withActivity - 新的取代活動。

傳回:

工作，表示要執行的工作佇列。

適用於