TurnContext インターフェイス

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)

リソース応答を返さずに、受信アクティビティの送信者にアクティビティを送信します。

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)

既存のアクティビティを削除します。

Parameters:

conversationReference - 削除するアクティビティを含む会話。

Returns:

実行するキューに登録された作業を表すタスク。 スレッド参照の ConversationReference#getActivityId は、削除するスレッド内のアクティビティを示します。

deleteActivity

public abstract CompletableFuture deleteActivity(String activityId)

既存のアクティビティを削除します。

Parameters:

activityId - 削除するアクティビティの ID。

Returns:

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

getActivity

public abstract Activity getActivity()

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

Returns:

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

getAdapter

public abstract BotAdapter getAdapter()

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

Returns:

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

getLocale

public abstract String getLocale()

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

Returns:

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

getResponded

public abstract boolean getResponded()

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

Returns:

true 現在のターンに対して少なくとも 1 つの応答が送信された場合。それ以外の場合は false

getTurnState

public abstract TurnContextStateCollection getTurnState()

ターンの有効期間中にコンテキスト オブジェクトと共にキャッシュされた値のコレクションを取得します。

Returns:

このコンテキスト オブジェクトに登録されているサービスのコレクション。

onDeleteActivity

public abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

削除アクティビティ操作の応答ハンドラーを追加します。

コンテキスト deleteActivity(String activityId) の が呼び出されると、アダプターは登録されたハンドラーをコンテキスト オブジェクトに追加された順序で呼び出します。

Parameters:

handler - コンテキスト オブジェクトに追加するハンドラー。

Returns:

更新されたコンテキスト オブジェクト。

onSendActivities

public abstract TurnContext onSendActivities(SendActivitiesHandler handler)

送信アクティビティ操作の応答ハンドラーを追加します。

コンテキストまたはsendActivity(Activity activity)sendActivities(List<Activity> activities)メソッドが呼び出されると、アダプターは登録されたハンドラーをコンテキスト オブジェクトに追加された順序で呼び出します。

Parameters:

handler - コンテキスト オブジェクトに追加するハンドラー。

Returns:

更新されたコンテキスト オブジェクト。

onUpdateActivity

public abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

更新アクティビティ操作の応答ハンドラーを追加します。

コンテキスト updateActivity(Activity withActivity) の が呼び出されると、アダプターは登録されたハンドラーをコンテキスト オブジェクトに追加された順序で呼び出します。

Parameters:

handler - コンテキスト オブジェクトに追加するハンドラー。

Returns:

更新されたコンテキスト オブジェクト。

sendActivities

public default CompletableFuture sendActivities(Activity[] activities)

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

Parameters:

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

Returns:

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

sendActivities

public abstract CompletableFuture sendActivities(List activities)

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

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

Parameters:

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

Returns:

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

sendActivity

public abstract CompletableFuture sendActivity(Activity activity)

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

Parameters:

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

Returns:

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

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend)

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

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

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

Parameters:

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

Returns:

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

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak)

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

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

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

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

Parameters:

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

Returns:

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

sendActivity

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

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

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

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

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

Parameters:

textReplyToSend - 送信するメッセージのテキスト。
speak - オプション。音声対応チャネルでボットによって読み上げられるテキスト。
inputHint - 省略可能。 は、メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、想定しているか、無視しているかを示します。 "acceptingInput"、"ignoringInput"、または "expectingInput" のいずれか。 既定値は "acceptingInput" です。

Returns:

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

sendActivityBlind

public default CompletableFuture sendActivityBlind(Activity activity)

ResourceResponse を返さずに、受信アクティビティの送信者にアクティビティを送信します。

Parameters:

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

Returns:

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

setLocale

public abstract void setLocale(String withLocale)

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

Parameters:

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

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name)

Parameters:

turnContext - turnContext。
name - アクティビティの名前。

Returns:

ResourceReponse を使用した未来。

traceActivity

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

ログ記録のために、 に BotAdapter トレース アクティビティを送信します。

Parameters:

turnContext - 現在のターンのコンテキスト。
name - アクティビティ Activity#getName の プロパティに割り当てる値。
value - アクティビティ Activity#getValue の プロパティに割り当てる値。
valueType - アクティビティ Activity#getValueType の プロパティに割り当てる値。
label - アクティビティ Activity#getLabel の プロパティに割り当てる値。

Returns:

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

updateActivity

public abstract CompletableFuture updateActivity(Activity withActivity)

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

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

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

Parameters:

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

Returns:

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

適用対象