BotAdapter クラス

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

public abstract class BotAdapter

ボットをサービス エンドポイントに接続できるボット アダプターを表します。 このクラスは抽象クラスです。

ボット アダプターでは、認証プロセスのカプセル化、および Bot Connector Service との間でのアクティビティの送受信が行われます。 ボットがアクティビティを受信すると、アダプターはコンテキスト オブジェクトを作成し、それをボットのアプリケーション ロジックに渡し、応答をユーザーのチャネルに送り返します。

adapter\u2019s ミドルウェア コレクションにオブジェクトを追加Middlewareするには、 を使用use(Middleware middleware)します。 アダプターは、ボット ミドルウェア パイプラインを介して で受信アクティビティを処理し、bot\u2019s ロジックに転送してから、もう一度戻します。 各アクティビティがボットを出入りして流れる際、ボット ロジックの実行前と実行後のどちらでも、各ミドルウェアがアクティビティを検査または操作できます。

TurnContext Activity Bot Middleware

フィールドの概要

修飾子と型 フィールドと説明
static final java.lang.String BOT_IDENTITY_KEY

ボットクレーム ID を格納するためのキー。
static final java.lang.String OAUTH_CLIENT_KEY

ボット oauth クライアントを格納するためのキー。
static final java.lang.String OAUTH_SCOPE_KEY

ボットの oauth スコープを格納するためのキー。

コンストラクターの概要

コンストラクター 説明
BotAdapter()

メソッドの概要

修飾子と型 メソッドと説明
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

プロアクティブ メッセージを会話に送信します。
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

プロアクティブ メッセージを会話に送信します。
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

プロアクティブ メッセージを会話に送信します。
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

プロアクティブ メッセージを会話に送信します。
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

プロアクティブ メッセージを会話に送信します。
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

プロアクティブ メッセージを会話に送信します。
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(TurnContext context, ConversationReference reference)

派生クラスでオーバーライドされると、会話内の既存のアクティビティを削除します。
protected MiddlewareSet getMiddlewareSet()

アダプターのパイプライン内のミドルウェアのコレクションを取得します。
OnTurnErrorHandler getOnTurnError()

ミドルウェアまたはアプリケーションで例外をキャッチできるエラー ハンドラーを取得します。
protected java.util.concurrent.CompletableFuture<java.lang.Void> runPipeline(TurnContext context, BotCallbackHandler callback)

現在のボット ターンのアクティビティ処理を開始します。
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(TurnContext context, List<Activity> activities)

派生クラスでオーバーライドされると、アクティビティが会話に送信されます。
void setOnTurnError(OnTurnErrorHandler withTurnError)

ミドルウェアまたはアプリケーションで例外をキャッチできるエラー ハンドラーを設定します。
abstract java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(TurnContext context, Activity activity)

派生クラスでオーバーライドされた場合は、会話内の既存のアクティビティを置き換えます。
BotAdapter use(Middleware middleware)

アダプターのパイプラインにミドルウェアを追加します。

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

フィールドの詳細

BOT_IDENTITY_KEY

public static final String BOT_IDENTITY_KEY

ボットクレーム ID を格納するためのキー。

OAUTH_CLIENT_KEY

public static final String OAUTH_CLIENT_KEY

ボット oauth クライアントを格納するためのキー。

OAUTH_SCOPE_KEY

public static final String OAUTH_SCOPE_KEY

ボットの oauth スコープを格納するためのキー。

コンストラクターの詳細

BotAdapter

public BotAdapter()

メソッドの詳細

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

プロアクティブ メッセージを会話に送信します。

このメソッドを呼び出して、メッセージを会話に事前に送信します。 ほとんどのチャネルでは、ボットがアクティビティをユーザーに送信する前に、ユーザーがボットとの会話を開始する必要があります。

Parameters:

claimsIdentity - 会話の ClaimsIdentity。
continuationActivity - 会話を続行する適切な ConversationReference を持つアクティビティ。
callback - 結果ボットターンを呼び出すメソッド。

Returns:

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

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

プロアクティブ メッセージを会話に送信します。

このメソッドを呼び出して、メッセージを会話に事前に送信します。 ほとんどのチャネルでは、ボットがアクティビティをユーザーに送信する前に、ユーザーがボットとの会話を開始する必要があります。

Parameters:

claimsIdentity - 会話の ClaimsIdentity。
continuationActivity - 会話を続行する適切な ConversationReference を持つアクティビティ。
audience - プロアクティブ メッセージの受信者を示す 値。
callback - 結果ボットターンを呼び出すメソッド。

Returns:

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

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

プロアクティブ メッセージを会話に送信します。

このメソッドを呼び出して、メッセージを会話に事前に送信します。 ほとんどのチャネルでは、ボットがアクティビティをユーザーに送信する前に、ユーザーがボットとの会話を開始する必要があります。

Parameters:

claimsIdentity - 会話の ClaimsIdentity 参照。
reference - 続行する会話への参照。
callback - 結果ボットターンを呼び出すメソッド。

Returns:

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

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

プロアクティブ メッセージを会話に送信します。

このメソッドを呼び出して、メッセージを会話に事前に送信します。 ほとんどのチャネルでは、ボットがアクティビティをユーザーに送信する前に、ユーザーがボットとの会話を開始する必要があります。

Parameters:

claimsIdentity - 会話の ClaimsIdentity 参照。
reference - 続行する会話への参照。
audience - プロアクティブ メッセージの受信者を示す 値。
callback - 結果ボットターンを呼び出すメソッド。

Returns:

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

continueConversation

public CompletableFuture continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

プロアクティブ メッセージを会話に送信します。

このメソッドを呼び出して、メッセージを会話に事前に送信します。 ほとんどのチャネルでは、ボットがアクティビティをユーザーに送信する前に、ユーザーがボットとの会話を開始する必要があります。

Parameters:

botId - ボットのアプリケーション ID。 このパラメーターは、単一テナントのアダプター (コンソール、テストなど) では無視されますが、マルチテナント対応の BotFrameworkAdapter にとって重要です。
continuationActivity - 会話を続行する適切な ConversationReference を持つアクティビティ。
callback - 結果ボットターンを呼び出すメソッド。

Returns:

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

continueConversation

public CompletableFuture continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

プロアクティブ メッセージを会話に送信します。

Parameters:

botAppId - ボットのアプリケーション ID。 このパラメーターは、単一テナントのアダプター (コンソール、テストなど) では無視されますが、マルチテナント対応の BotFrameworkAdapter にとって重要です。
reference - 続行する会話への参照。
callback - 結果のボット ターンを呼び出すメソッド。

Returns:

実行するキューに登録された作業を表すタスク。 このメソッドを呼び出して、メッセージを会話に事前に送信します。 ほとんどのチャネルでは、ボットがアクティビティをユーザーに送信する前に、ユーザーがボットとの会話を開始する必要があります。 
     <xref uid="com.microsoft.bot.builder.BotAdapter.runPipeline(com.microsoft.bot.builder.TurnContext,com.microsoft.bot.builder.BotCallbackHandler)" data-throw-if-not-resolved="false" data-raw-source="#runPipeline(TurnContext, BotCallbackHandler)"></xref>

deleteActivity

public abstract CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

派生クラスでオーバーライドされると、会話内の既存のアクティビティを削除します。

Parameters:

context - ターンのコンテキスト オブジェクト。
reference - 削除するアクティビティの会話参照。

Returns:

実行するキューに登録された作業を表すタスク。 メッセージ交換参照の は ConversationReference#getActivityId 、削除するアクティビティを識別します。 onDeleteActivity(DeleteActivityHandler handler)

getMiddlewareSet

protected MiddlewareSet getMiddlewareSet()

アダプターのパイプライン内のミドルウェアのコレクションを取得します。

Returns:

パイプラインのミドルウェア コレクション。

getOnTurnError

public OnTurnErrorHandler getOnTurnError()

ミドルウェアまたはアプリケーションで例外をキャッチできるエラー ハンドラーを取得します。

Returns:

ミドルウェアまたはアプリケーションで例外をキャッチできるエラー ハンドラー。

runPipeline

protected CompletableFuture runPipeline(TurnContext context, BotCallbackHandler callback)

現在のボット ターンのアクティビティ処理を開始します。 アダプターは、ミドルウェアを追加した順序でミドルウェアを呼び出します。 アダプターはターンのコンテキスト オブジェクトと next デリゲートを渡し、ミドルウェアはデリゲートを呼び出してパイプライン内の次のミドルウェアに制御を渡します。 コントロールがパイプラインの末尾に達すると、アダプターは メソッドを callback 呼び出します。 ミドルウェア コンポーネントが次のデリゲートを呼び出さない場合、アダプターは後続のミドルウェア\u2019s onTurn(TurnContext turnContext, NextDelegate next) メソッドまたはコールバック メソッド、およびパイプラインの短絡を呼び出しません。

ターンがユーザー アクティビティ (リアクティブ メッセージング) によって開始されると、コールバック メソッドはボットの onTurn(TurnContext turnContext) メソッドへの参照になります。 ターンが への continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) 呼び出し (プロアクティブ メッセージング) によって開始されると、コールバック メソッドは呼び出しで提供されたコールバック メソッドです。

Parameters:

context - ターンのコンテキスト オブジェクト。
callback - パイプラインの末尾で実行するコールバック メソッド。

Returns:

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

sendActivities

public abstract CompletableFuture sendActivities(TurnContext context, List activities)

派生クラスでオーバーライドされると、アクティビティが会話に送信されます。

Parameters:

context - ターンのコンテキスト オブジェクト。
activities - 送信するアクティビティ。

Returns:

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

setOnTurnError

public void setOnTurnError(OnTurnErrorHandler withTurnError)

ミドルウェアまたはアプリケーションで例外をキャッチできるエラー ハンドラーを設定します。

Parameters:

withTurnError - ミドルウェアまたはアプリケーションで例外をキャッチできるエラー ハンドラー。

updateActivity

public abstract CompletableFuture updateActivity(TurnContext context, Activity activity)

派生クラスでオーバーライドされた場合は、会話内の既存のアクティビティを置き換えます。

Parameters:

context - ターンのコンテキスト オブジェクト。
activity - 新しい置換アクティビティ。

Returns:

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

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

use

public BotAdapter use(Middleware middleware)

アダプターのパイプラインにミドルウェアを追加します。

Parameters:

middleware - 追加するミドルウェア。

Returns:

更新されたアダプター オブジェクト。 ミドルウェアは、初期化時にアダプターに追加されます。 各ターンについて、アダプターはミドルウェアを追加した順序でミドルウェアを呼び出します。

適用対象