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 との間でアクティビティを送受信します。 ボットがアクティビティを受信すると、アダプターはコンテキスト オブジェクトを作成し、それをボットのアプリケーション ロジックに渡し、応答をユーザーのチャネルに返します。

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

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)

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

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

パラメーター:

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

戻り値:

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

continueConversation

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

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

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

パラメーター:

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

戻り値:

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

continueConversation

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

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

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

パラメーター:

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

戻り値:

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

continueConversation

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

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

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

パラメーター:

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

戻り値:

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

continueConversation

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

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

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

パラメーター:

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

戻り値:

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

continueConversation

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

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

パラメーター:

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

戻り値:

実行するキューに登録された作業を表すタスク。 メッセージを会話に事前に送信するには、このメソッドを呼び出します。 ほとんどのチャネルでは、ボットがユーザーにアクティビティを送信する前に、ユーザーがボットとの会話を開始する必要があります。 
     <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)

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

パラメーター:

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

戻り値:

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

getMiddlewareSet

protected MiddlewareSet getMiddlewareSet()

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

戻り値:

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

getOnTurnError

public OnTurnErrorHandler getOnTurnError()

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

戻り値:

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

runPipeline

protected CompletableFuture runPipeline(TurnContext context, BotCallbackHandler callback)

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

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

パラメーター:

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

戻り値:

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

sendActivities

public abstract CompletableFuture sendActivities(TurnContext context, List activities)

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

パラメーター:

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

戻り値:

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

setOnTurnError

public void setOnTurnError(OnTurnErrorHandler withTurnError)

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

パラメーター:

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

updateActivity

public abstract CompletableFuture updateActivity(TurnContext context, Activity activity)

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

パラメーター:

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

戻り値:

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

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

use

public BotAdapter use(Middleware middleware)

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

パラメーター:

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

戻り値:

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

適用対象