DelegatingTurnContext クラス

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

実装

TurnContext の

public class DelegatingTurnContext
implements TurnContext

型指定されていない内部 TurnContext をラップする TurnContext。

コンストラクターの概要

コンストラクター 説明
DelegatingTurnContext(TurnContext withTurnContext)

DelegatingTurnContext クラスの新しいインスタンスを初期化します。

メソッドの概要

修飾子と型 メソッドと説明
java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(ConversationReference conversationReference)

既存のアクティビティを削除します。
java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(String activityId)

既存のアクティビティを削除します。
Activity getActivity()

内部コンテキストのアクティビティを取得します。
BotAdapter getAdapter()

内部コンテキストのアクティビティを取得します。
java.lang.String getLocale()

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

内部コンテキストの応答値を取得します。
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 activity)

受信アクティビティの送信者にアクティビティを送信します。
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 activity)

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

メソッドの継承元: 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

コンストラクターの詳細

DelegatingTurnContext

public DelegatingTurnContext(TurnContext withTurnContext)

DelegatingTurnContext クラスの新しいインスタンスを初期化します。

パラメーター:

withTurnContext - ラップする TurnContext。

メソッドの詳細

deleteActivity

public CompletableFuture deleteActivity(ConversationReference conversationReference)

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

パラメーター:

conversationReference

deleteActivity

public CompletableFuture deleteActivity(String activityId)

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

パラメーター:

activityId

getActivity

public Activity getActivity()

内部コンテキストのアクティビティを取得します。

戻り値:

内部 getActivity()。

getAdapter

public BotAdapter getAdapter()

内部コンテキストのアクティビティを取得します。

戻り値:

内部 getAdapter()。

getLocale

public String getLocale()

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

戻り値:

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

getResponded

public boolean getResponded()

内部コンテキストの応答値を取得します。

戻り値:

内部 getResponded()。

getTurnState

public TurnContextStateCollection getTurnState()

内部コンテキストのアクティビティを取得します。

戻り値:

内部 getTurnState()。

onDeleteActivity

public TurnContext onDeleteActivity(DeleteActivityHandler handler)

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

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

パラメーター:

handler

onSendActivities

public TurnContext onSendActivities(SendActivitiesHandler handler)

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

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

パラメーター:

handler

onUpdateActivity

public TurnContext onUpdateActivity(UpdateActivityHandler handler)

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

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

パラメーター:

handler

sendActivities

public CompletableFuture sendActivities(List activities)

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

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

パラメーター:

activities

sendActivity

public CompletableFuture sendActivity(Activity activity)

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

パラメーター:

activity

sendActivity

public CompletableFuture sendActivity(String textReplyToSend)

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

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

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

パラメーター:

textReplyToSend

sendActivity

public CompletableFuture sendActivity(String textReplyToSend, String speak)

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

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

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

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

パラメーター:

textReplyToSend
speak

sendActivity

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

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

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

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

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

パラメーター:

textReplyToSend
speak
inputHint

setLocale

public void setLocale(String withLocale)

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

パラメーター:

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

updateActivity

public CompletableFuture updateActivity(Activity activity)

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

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

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

パラメーター:

activity

適用対象