TurnContextImpl クラス
- java.
lang. Object - com.
microsoft. bot. builder. TurnContextImpl
- com.
実装
public class TurnContextImpl
implements TurnContext, java.lang.AutoCloseable
ボットのターンのコンテキストを提供します。 コンテキストは、受信アクティビティを処理するために必要な情報を提供します。 コンテキスト オブジェクトは BotAdapter によって作成され、ターンの長さのために保持されます。 Bot Middleware
コンストラクターの概要
| コンストラクター | 説明 |
|---|---|
| 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()
このターンに関連付けられているアクティビティを取得します。またはプロアクティブ メッセージを処理するときに |
|
Bot |
getAdapter()
このコンテキスト オブジェクトを作成したボット アダプターを取得します。 |
| java.util.List<Activity> |
getBufferedReplyActivities()
"context" のときに送信するアクティビティの一覧を取得します。 |
| java.lang.String |
getLocale()
このコンテキスト オブジェクトのロケールを取得します。 |
| boolean |
getResponded()
現在のターンに対して少なくとも 1 つの応答が送信されたかどうかを示します。 |
|
Turn |
getTurnState()
このコンテキスト オブジェクトに登録されているサービスを取得します。 |
|
Turn |
onDeleteActivity(DeleteActivityHandler handler)
削除アクティビティ操作の応答ハンドラーを追加します。 |
|
Turn |
onSendActivities(SendActivitiesHandler handler)
送信アクティビティ操作の応答ハンドラーを追加します。 |
|
Turn |
onUpdateActivity(UpdateActivityHandler handler)
更新アクティビティ操作の応答ハンドラーを追加します。 |
|
java.util.concurrent.CompletableFuture<Resource |
sendActivities(List<Activity> activities)
受信アクティビティの送信者に一連のアクティビティを送信します。 |
|
java.util.concurrent.CompletableFuture<Resource |
sendActivity(Activity activityToSend)
受信アクティビティの送信者にアクティビティを送信します。 |
|
java.util.concurrent.CompletableFuture<Resource |
sendActivity(String textReplyToSend)
受信アクティビティの送信者にメッセージ アクティビティを送信します。 |
|
java.util.concurrent.CompletableFuture<Resource |
sendActivity(String textReplyToSend, String speak)
受信アクティビティの送信者にメッセージ アクティビティを送信します。 |
|
java.util.concurrent.CompletableFuture<Resource |
sendActivity(String textReplyToSend, String speak, InputHints inputHint)
受信アクティビティの送信者にメッセージ アクティビティを送信します。 |
| void |
setLocale(String withLocale)
このコンテキスト オブジェクトにロケールを設定します。 |
|
java.util.concurrent.CompletableFuture<Resource |
updateActivity(Activity withActivity)
既存のアクティビティを置き換えます。 |
メソッドの継承元: java.lang.Object
コンストラクターの詳細
TurnContextImpl
public TurnContextImpl(BotAdapter withAdapter, Activity withActivity)
コンテキスト オブジェクトを作成します。
パラメーター:
null します。
メソッドの詳細
close
public void close()
AutoClosable#close。
スロー:
deleteActivity
public CompletableFuture
既存のアクティビティを削除します。 会話参照の ConversationReference#getActivityId は、削除する会話内のアクティビティを示します。
パラメーター:
戻り値:
deleteActivity
public CompletableFuture
既存のアクティビティを削除します。
パラメーター:
戻り値:
finalize
public void finalize()
#closeの自動呼び出し。
上書き:
TurnContextImpl.finalize()getActivity
public Activity getActivity()
このターンに関連付けられているアクティビティを取得します。またはプロアクティブ メッセージを処理するときに null します。
getAdapter
public BotAdapter getAdapter()
このコンテキスト オブジェクトを作成したボット アダプターを取得します。
戻り値:
getBufferedReplyActivities
public List
"context" のときに送信するアクティビティの一覧を取得します。Activity.DeliveryMode == 'expectReplies'。
戻り値:
getLocale
public String getLocale()
このコンテキスト オブジェクトのロケールを取得します。
戻り値:
getResponded
public boolean getResponded()
現在のターンに対して少なくとも 1 つの応答が送信されたかどうかを示します。
戻り値:
true します。getTurnState
public TurnContextStateCollection getTurnState()
このコンテキスト オブジェクトに登録されているサービスを取得します。
戻り値:
onDeleteActivity
public TurnContext onDeleteActivity(DeleteActivityHandler handler)
削除アクティビティ操作の応答ハンドラーを追加します。
パラメーター:
戻り値:
onSendActivities
public TurnContext onSendActivities(SendActivitiesHandler handler)
送信アクティビティ操作の応答ハンドラーを追加します。
パラメーター:
戻り値:
onUpdateActivity
public TurnContext onUpdateActivity(UpdateActivityHandler handler)
更新アクティビティ操作の応答ハンドラーを追加します。
パラメーター:
戻り値:
sendActivities
public CompletableFuture
受信アクティビティの送信者に一連のアクティビティを送信します。
パラメーター:
戻り値:
sendActivity
public CompletableFuture
受信アクティビティの送信者にアクティビティを送信します。
パラメーター:
戻り値:
sendActivity
public CompletableFuture
受信アクティビティの送信者にメッセージ アクティビティを送信します。
アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む ResourceResponse オブジェクトが含まれます。
textReplyToSendの内容に課せられる制限については、チャネルのドキュメントを参照してください。
パラメーター:
戻り値:
sendActivity
public CompletableFuture
受信アクティビティの送信者にメッセージ アクティビティを送信します。
アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む ResourceResponse オブジェクトが含まれます。
textReplyToSendの内容に課せられる制限については、チャネルのドキュメントを参照してください。
パラメーター:
戻り値:
sendActivity
public CompletableFuture
受信アクティビティの送信者にメッセージ アクティビティを送信します。
アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む ResourceResponse オブジェクトが含まれます。
textReplyToSendの内容に課せられる制限については、チャネルのドキュメントを参照してください。
パラメーター:
戻り値:
setLocale
public void setLocale(String withLocale)
このコンテキスト オブジェクトにロケールを設定します。
パラメーター:
updateActivity
public CompletableFuture
既存のアクティビティを置き換えます。
パラメーター:
戻り値: