TurnContext インターフェイス
public interface TurnContext
ボットのターンのコンテキストを提供します。
コンテキストは、受信アクティビティを処理するために必要な情報を提供します。 コンテキスト オブジェクトは によって BotAdapter 作成され、ターンの長さに対して保持されます。
フィールドの概要
修飾子と型 | フィールドと説明 |
---|---|
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
Bot |
getAdapter()
このコンテキスト オブジェクトを作成したボット アダプターを取得します。 |
abstract java.lang.String |
getLocale()
このコンテキスト オブジェクトのロケールを取得します。 |
abstract boolean |
getResponded()
現在のターンに対して少なくとも 1 つの応答が送信されたかどうかを示す値を取得します。 |
abstract
Turn |
getTurnState()
ターンの有効期間中にコンテキスト オブジェクトと共にキャッシュされた値のコレクションを取得します。 |
abstract
Turn |
onDeleteActivity(DeleteActivityHandler handler)
削除アクティビティ操作の応答ハンドラーを追加します。 |
abstract
Turn |
onSendActivities(SendActivitiesHandler handler)
送信アクティビティ操作の応答ハンドラーを追加します。 |
abstract
Turn |
onUpdateActivity(UpdateActivityHandler handler)
更新アクティビティ操作の応答ハンドラーを追加します。 |
default
java.util.concurrent.CompletableFuture<Resource |
sendActivities(Activity[] activities)
アクティビティの配列を送信するヘルパー メソッド。 |
abstract
java.util.concurrent.CompletableFuture<Resource |
sendActivities(List<Activity> activities)
受信アクティビティの送信者にアクティビティの一覧を送信します。 |
abstract
java.util.concurrent.CompletableFuture<Resource |
sendActivity(Activity activity)
受信アクティビティの送信者にアクティビティを送信します。 |
abstract
java.util.concurrent.CompletableFuture<Resource |
sendActivity(String textReplyToSend)
受信アクティビティの送信者にメッセージ アクティビティを送信します。 |
abstract
java.util.concurrent.CompletableFuture<Resource |
sendActivity(String textReplyToSend, String speak)
受信アクティビティの送信者にメッセージ アクティビティを送信します。 |
abstract
java.util.concurrent.CompletableFuture<Resource |
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<Resource |
traceActivity(TurnContext turnContext, String name) |
static
java.util.concurrent.CompletableFuture<Resource |
traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label)
ログ記録のために、 に BotAdapter トレース アクティビティを送信します。 |
abstract
java.util.concurrent.CompletableFuture<Resource |
updateActivity(Activity withActivity)
既存のアクティビティを置き換えます。 |
フィールドの詳細
STATE_TURN_LOCALE
public static final String STATE_TURN_LOCALE
メソッドの詳細
deleteActivity
public abstract CompletableFuture
既存のアクティビティを削除します。
Parameters:
Returns:
deleteActivity
public abstract CompletableFuture
既存のアクティビティを削除します。
Parameters:
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:
Returns:
onSendActivities
public abstract TurnContext onSendActivities(SendActivitiesHandler handler)
送信アクティビティ操作の応答ハンドラーを追加します。
コンテキストまたはsendActivity(Activity activity)sendActivities(List<Activity> activities)メソッドが呼び出されると、アダプターは登録されたハンドラーをコンテキスト オブジェクトに追加された順序で呼び出します。
Parameters:
Returns:
onUpdateActivity
public abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)
更新アクティビティ操作の応答ハンドラーを追加します。
コンテキスト updateActivity(Activity withActivity) の が呼び出されると、アダプターは登録されたハンドラーをコンテキスト オブジェクトに追加された順序で呼び出します。
Parameters:
Returns:
sendActivities
public default CompletableFuture
アクティビティの配列を送信するヘルパー メソッド。 これにより、 が呼び出されます sendActivities(List<Activity> activities)。
Parameters:
Returns:
sendActivities
public abstract CompletableFuture
受信アクティビティの送信者にアクティビティの一覧を送信します。
アクティビティが正常に送信されると、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含むオブジェクトの配列 ResourceResponse が含まれます。
Parameters:
Returns:
sendActivity
public abstract CompletableFuture
受信アクティビティの送信者にアクティビティを送信します。
Parameters:
Returns:
sendActivity
public abstract CompletableFuture
受信アクティビティの送信者にメッセージ アクティビティを送信します。
アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む オブジェクトが含まれます ResourceResponse 。
の内容に適用される制限については、チャネルの textReplyToSend
ドキュメントを参照してください。
Parameters:
Returns:
sendActivity
public abstract CompletableFuture
受信アクティビティの送信者にメッセージ アクティビティを送信します。
アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む オブジェクトが含まれます ResourceResponse 。
の内容に適用される制限については、チャネルの textReplyToSend
ドキュメントを参照してください。
音声、速度、音量、発音、ピッチなど、ボットの音声のさまざまな特性を制御するには、音声合成マークアップ言語 (SSML) 形式で を指定 speak
します。
Parameters:
Returns:
sendActivity
public abstract CompletableFuture
受信アクティビティの送信者にメッセージ アクティビティを送信します。
アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む オブジェクトが含まれます ResourceResponse 。
の内容に適用される制限については、チャネルの textReplyToSend
ドキュメントを参照してください。
音声、速度、音量、発音、ピッチなど、ボットの音声のさまざまな特性を制御するには、音声合成マークアップ言語 (SSML) 形式で を指定 speak
します。
Parameters:
Returns:
sendActivityBlind
public default CompletableFuture
ResourceResponse を返さずに、受信アクティビティの送信者にアクティビティを送信します。
Parameters:
Returns:
setLocale
public abstract void setLocale(String withLocale)
このコンテキスト オブジェクトにロケールを設定します。
Parameters:
traceActivity
public static CompletableFuture
Parameters:
Returns:
traceActivity
public static CompletableFuture
ログ記録のために、 に BotAdapter トレース アクティビティを送信します。
Parameters:
Returns:
updateActivity
public abstract CompletableFuture
既存のアクティビティを置き換えます。
アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む オブジェクトが含まれます ResourceResponse 。
これを呼び出す前に、置換アクティビティの ID を置換するアクティビティの ID に設定します。
Parameters:
Returns: