TurnContext インターフェイス

  • リファレンス
パッケージ:
com.microsoft.bot.builder
Maven 成果物:
com.microsoft.bot:bot-builder:4.14.3

public interface TurnContext

ボットのターンのコンテキストを提供します。

コンテキストは、受信アクティビティを処理するために必要な情報を提供します。 コンテキスト オブジェクトは 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()

ボットのこのターンのアクティビティを取得します。
abstract BotAdapter getAdapter()

このコンテキスト オブジェクトを作成したボット アダプターを取得します。
abstract java.lang.String getLocale()

このコンテキスト オブジェクトのロケールを取得します。
abstract boolean getResponded()

現在のターンに対して少なくとも 1 つの応答が送信されたかどうかを示す値を取得します。
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)

アクティビティの配列を送信するヘルパー メソッド。
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)

ResourceResponse を返さずに、受信アクティビティの送信者にアクティビティを送信します。
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 - 削除するアクティビティの ID。

戻り値:

実行するキューに登録された作業を表すタスク。

getActivity

public abstract Activity getActivity()

ボットのこのターンのアクティビティを取得します。

戻り値:

ボットのこのターンのアクティビティ。

getAdapter

public abstract BotAdapter getAdapter()

このコンテキスト オブジェクトを作成したボット アダプターを取得します。

戻り値:

このコンテキスト オブジェクトを作成したボット アダプター。

getLocale

public abstract String getLocale()

このコンテキスト オブジェクトのロケールを取得します。

戻り値:

このコンテキスト オブジェクトのロケールの文字列。

getResponded

public abstract boolean getResponded()

現在のターンに対して少なくとも 1 つの応答が送信されたかどうかを示す値を取得します。

戻り値:

true 現在のターンに対して少なくとも 1 つの応答が送信された場合。それ以外の場合は、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)

アクティビティの配列を送信するヘルパー メソッド。 これは sendActivities(List<Activity> activities)を呼び出します。

パラメーター:

activities - アクティビティの配列。

戻り値:

実行するキューに登録された作業を表すタスク。

sendActivities

public abstract CompletableFuture sendActivities(List activities)

受信アクティビティの送信者にアクティビティの一覧を送信します。

アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む ResourceResponse オブジェクトの配列が含まれます。

パラメーター:

activities - 送信するアクティビティ。

戻り値:

実行するキューに登録された作業を表すタスク。

sendActivity

public abstract CompletableFuture sendActivity(Activity activity)

受信アクティビティの送信者にアクティビティを送信します。

パラメーター:

activity - 送信するアクティビティ。

戻り値:

実行するキューに登録された作業を表すタスク。 アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む ResourceResponse オブジェクトが含まれます。

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend)

受信アクティビティの送信者にメッセージ アクティビティを送信します。

アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む ResourceResponse オブジェクトが含まれます。

textReplyToSendの内容に課せられる制限については、チャネルのドキュメントを参照してください。

パラメーター:

textReplyToSend - 送信するメッセージのテキスト。

戻り値:

実行するキューに登録された作業を表すタスク。

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak)

受信アクティビティの送信者にメッセージ アクティビティを送信します。

アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む ResourceResponse オブジェクトが含まれます。

textReplyToSendの内容に課せられる制限については、チャネルのドキュメントを参照してください。

音声、レート、音量、発音、ピッチなど、ボットの音声のさまざまな特性を制御するには、音声合成マークアップ言語 (SSML) 形式で speak を指定します。

パラメーター:

textReplyToSend - 送信するメッセージのテキスト。
speak - オプション。音声対応チャネルでボットによって読み上げるテキスト。

戻り値:

実行するキューに登録された作業を表すタスク。

sendActivity

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

受信アクティビティの送信者にメッセージ アクティビティを送信します。

アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む ResourceResponse オブジェクトが含まれます。

textReplyToSendの内容に課せられる制限については、チャネルのドキュメントを参照してください。

音声、レート、音量、発音、ピッチなど、ボットの音声のさまざまな特性を制御するには、音声合成マークアップ言語 (SSML) 形式で speak を指定します。

パラメーター:

textReplyToSend - 送信するメッセージのテキスト。
speak - オプション。音声対応チャネルでボットによって読み上げるテキスト。
inputHint - 省略可能。メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、想定しているか、無視しているかを示します。 "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 プロパティに割り当てる値。

戻り値:

実行するキューに登録された作業を表すタスク。 アダプターがエミュレーターでホストされている場合、タスクの結果には、元のトレース アクティビティの ID を持つ ResourceResponse オブジェクトが含まれます。それ以外の場合は、受信チャネルがアクティビティに割り当てた ID を含む ResourceResponse オブジェクトが含まれます。

updateActivity

public abstract CompletableFuture updateActivity(Activity withActivity)

既存のアクティビティを置き換えます。

アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む ResourceResponse オブジェクトが含まれます。

これを呼び出す前に、置換アクティビティの ID を、置き換えるアクティビティの ID に設定します。

パラメーター:

withActivity - 新しい置換アクティビティ。

戻り値:

実行するキューに登録された作業を表すタスク。

適用対象