TurnContextImpl 類別

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

實作

TurnContext java.lang.AutoCloseable

public class TurnContextImpl
implements TurnContext, java.lang.AutoCloseable

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

建構函式摘要

建構函式 Description
TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

建立內容物件。

方法摘要

修飾詞與類型 方法與描述
void close()

自動Closable#close。
java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(ConversationReference conversationReference)

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

刪除現有的活動。
void finalize()

自動呼叫 #close。
Activity getActivity()

取得與此回合相關聯的活動;或處理主動式訊息時 null。
BotAdapter getAdapter()

取得建立此內容物件的 Bot 配接器。
java.util.List<Activity> getBufferedReplyActivities()

取得當 『context』 時要傳送的活動清單。活動。傳遞模式 == 'expect回復'。
java.lang.String getLocale()

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

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

取得在此內容對象上註冊的服務。
TurnContext onDeleteActivity(DeleteActivityHandler handler)

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

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

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

將一組活動傳送給傳入活動的傳送者。
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(Activity activityToSend)

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

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

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

將訊息活動傳送給傳入活動的傳送者。
void setLocale(String withLocale)

在此內容物件上設定地區設定。
java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(Activity withActivity)

取代現有的活動。

方法繼承來源 java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

建構函式詳細資料

TurnContextImpl

public TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

建立內容物件。

參數:

withAdapter - 建立內容的配接器。
withActivity - 回合的傳入活動;或針對主動式訊息進行回合 null。

方法詳細資料

close

public void close()

AutoClosable#close。

擲回:

java.lang.Exception - 如果 TurnContextStateCollection。

deleteActivity

public CompletableFuture deleteActivity(ConversationReference conversationReference)

刪除現有的活動。 交談參考的 ConversationReference#getActivityId 指出要刪除之交談中的活動。

參數:

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

傳回:

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

deleteActivity

public CompletableFuture deleteActivity(String activityId)

刪除現有的活動。

參數:

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

傳回:

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

finalize

public void finalize()

自動呼叫 #close。

覆寫:

TurnContextImpl.finalize()

getActivity

public Activity getActivity()

取得與此回合相關聯的活動;或處理主動式訊息時 null。

getAdapter

public BotAdapter getAdapter()

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

傳回:

此回合的 BotAdaptor。

getBufferedReplyActivities

public List getBufferedReplyActivities()

取得當 『context』 時要傳送的活動清單。Activity.DeliveryMode == 'expectReplies'。

傳回:

活動清單。

getLocale

public String getLocale()

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

傳回:

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

getResponded

public boolean getResponded()

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

傳回:

如果至少有一個回應已針對目前的回合傳送，true。

getTurnState

public TurnContextStateCollection getTurnState()

取得在此內容對象上註冊的服務。

傳回:

此回合的 TurnContextStateCollection。

onDeleteActivity

public TurnContext onDeleteActivity(DeleteActivityHandler handler)

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

參數:

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

傳回:

更新的內容物件。

onSendActivities

public TurnContext onSendActivities(SendActivitiesHandler handler)

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

參數:

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

傳回:

更新的內容物件。

onUpdateActivity

public TurnContext onUpdateActivity(UpdateActivityHandler handler)

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

參數:

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

傳回:

更新的內容物件。

sendActivities

public CompletableFuture sendActivities(List activities)

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

參數:

activities - 要傳送的活動。

傳回:

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

sendActivity

public CompletableFuture sendActivity(Activity activityToSend)

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

參數:

activityToSend - 要傳送的活動。

傳回:

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

sendActivity

public CompletableFuture sendActivity(String textReplyToSend)

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

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

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

參數:

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

傳回:

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

sendActivity

public CompletableFuture sendActivity(String textReplyToSend, String speak)

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

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

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

參數:

textReplyToSend - 要傳送之訊息的文字。
speak - 若要控制 Bot 語音的各種特性，例如語音速率、音量、發音和音調，請指定語音合成標記語言 （SSML） 格式。

傳回:

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

sendActivity

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

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

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

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

參數:

textReplyToSend - 要傳送之訊息的文字。
speak - 若要控制 Bot 語音的各種特性，例如語音速率、音量、發音和音調，請指定語音合成標記語言 （SSML） 格式。
inputHint - （選擇性）輸入提示。

傳回:

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

setLocale

public void setLocale(String withLocale)

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

參數:

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

updateActivity

public CompletableFuture updateActivity(Activity withActivity)

取代現有的活動。

參數:

withActivity - 新的取代活動。

傳回:

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

適用於