TurnContextImpl クラス

  • java.lang.Object
    • com.microsoft.bot.builder.TurnContextImpl

実装

TurnContext java.lang.AutoCloseable する

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()

このターンに関連付けられているアクティビティを取得します。またはプロアクティブ メッセージを処理するときに null します。

BotAdapter getAdapter()

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

java.util.List<Activity> getBufferedReplyActivities()

"context" のときに送信するアクティビティの一覧を取得します。アクティビティ。配信モード == 'expectReplies'。

java.lang.String getLocale()

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

boolean getResponded()

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

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 - 削除するアクティビティの ID。

戻り値:

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

finalize

public void finalize()

#closeの自動呼び出し。

上書き:

TurnContextImpl.finalize()

getActivity

public Activity getActivity()

このターンに関連付けられているアクティビティを取得します。またはプロアクティブ メッセージを処理するときに null します。

getAdapter

public BotAdapter getAdapter()

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

戻り値:

このターンの BotAdaptor。

getBufferedReplyActivities

public List getBufferedReplyActivities()

"context" のときに送信するアクティビティの一覧を取得します。Activity.DeliveryMode == 'expectReplies'。

戻り値:

アクティビティの一覧。

getLocale

public String getLocale()

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

戻り値:

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

getResponded

public boolean getResponded()

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

戻り値:

現在のターンに対して少なくとも 1 つの応答が送信された場合に 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 - 送信するアクティビティ。

戻り値:

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

sendActivity

public CompletableFuture sendActivity(Activity activityToSend)

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

パラメーター:

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

戻り値:

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

sendActivity

public CompletableFuture sendActivity(String textReplyToSend)

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

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

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

パラメーター:

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

戻り値:

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

sendActivity

public CompletableFuture sendActivity(String textReplyToSend, String speak)

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

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

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

パラメーター:

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

戻り値:

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

sendActivity

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

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

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

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

パラメーター:

textReplyToSend - 送信するメッセージのテキスト。
speak - 音声レート、音量、発音、ピッチなど、ボットの音声のさまざまな特性を制御するには、音声合成マークアップ言語 (SSML) 形式を指定します。
inputHint - (省略可能)入力ヒント。

戻り値:

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

setLocale

public void setLocale(String withLocale)

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

パラメーター:

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

updateActivity

public CompletableFuture updateActivity(Activity withActivity)

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

パラメーター:

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

戻り値:

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

適用対象