ActivityHandlerBase class

  • リファレンス
パッケージ:
botbuilder-core

ボットのイベント出力アクティビティ ハンドラーのコア動作を定義します。

注釈

これにより、イベント ドリブンの方法で受信アクティビティを処理するための拡張可能なクラスが提供されます。 イベントの種類ごとに任意のハンドラー セットを登録できます。

イベントのハンドラーを登録するには、対応する on イベント メソッドを 使用します。 1 つのイベントに複数のハンドラーが登録されている場合は、登録された順序で実行されます。

このオブジェクトは、受信アクティビティを処理する際に一連の イベント を生成します。 ハンドラーは、継続関数を呼び出さないでイベントの伝達を停止できます。

イベントの種類 説明
型固有 任意のサブタイプのイベントを生成する前に、特定のアクティビティの種類に対して出力されます。
サブタイプ アクティビティ コンテンツに基づいて、特定の特殊なイベントに対して出力されます。

参照

メソッド

run(TurnContext)

イベントの放出プロセスを開始するために呼び出されます。

メソッドの詳細

run(TurnContext)

イベントの放出プロセスを開始するために呼び出されます。

function run(context: TurnContext): Promise<void>

パラメーター

context
TurnContext

現在のターンのコンテキスト オブジェクト。

戻り値

Promise<void>

注釈

通常は、受信したアクティビティがアダプターによって前処理され、ミドルウェアを介してルーティングされた後に、アダプターがボットのロジックを実行するために呼び出す関数ハンドラーとして、このメソッドを指定します。

例:

 server.post('/api/messages', (req, res) => {
     adapter.processActivity(req, res, async (context) => {
         // Route to main dialog.
         await bot.run(context);
     });
});

参照