TeamsActivityHandler class

チャネルの作成時など、TeamsChannelCreated イベントのハンドラーを登録します。

function onTeamsChannelCreatedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

チャネルが削除されたときなど、TeamsChannelDeleted イベントのハンドラーを登録します。

function onTeamsChannelDeletedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

チャネルの名前が変更されたときなど、TeamsChannelRenamed イベントのハンドラーを登録します。

function onTeamsChannelRenamedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

チャネルが復元されたときなど、TeamsChannelRestored イベントのハンドラーを登録します。

function onTeamsChannelRestoredEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

Teams 会議が終了したときのハンドラーを登録します。

function onTeamsMeetingEndEvent(handler: (meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

Teams 会議の開始時のハンドラーを登録します。

function onTeamsMeetingStartEvent(handler: (meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

ボットのウェルカム ロジックなど、ボット以外のメンバーがチャネルに参加する場合など、TeamsMembersAdded イベントのハンドラーを登録します。

function onTeamsMembersAddedEvent(handler: (membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

ボットのさよならロジックなど、ボット以外のメンバーがチャネルを離れる場合など、TeamsMembersRemoved イベントのハンドラーを登録します。

function onTeamsMembersRemovedEvent(handler: (membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

開封確認メッセージが送信されたときのハンドラーを登録します。

function onTeamsReadReceiptEvent(handler: (receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

チームがアーカイブされたときなど、TeamsTeamArchived イベントのハンドラーを登録します。

function onTeamsTeamArchivedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

チームが削除されたときなど、TeamsTeamDeleted イベントのハンドラーを登録します。

function onTeamsTeamDeletedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

チームがハード削除されたときなど、TeamsTeamHardDeleted イベントのハンドラーを登録します。

function onTeamsTeamHardDeletedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

チームの名前が変更されたときなど、TeamsTeamRenamed イベントのハンドラーを登録します。

function onTeamsTeamRenamedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

チームが復元されたときなど、TeamsTeamRestored イベントのハンドラーを登録します。

function onTeamsTeamRestoredEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

チームが整理されていない場合など、TeamsTeamUnarchived イベントのハンドラーを登録します。

function onTeamsTeamUnarchivedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

パラメーター

戻り値

キューに登録された作業を表す Promise。

コマンド アクティビティのアクティビティ イベント ハンドラーを登録します。

function onCommand(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

Command イベントを処理するには、onCommand 型固有のイベント ハンドラーを使用します。

ActivityHandler.onCommand から継承された

CommandResult アクティビティのアクティビティ イベント ハンドラーを登録します。

function onCommandResult(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

CommandResult イベントを処理するには、onCommandResult 型固有のイベント ハンドラーを使用します。

ActivityHandler.onCommandResult から継承された

会話更新 イベントのアクティビティ イベント ハンドラーを登録します。これは、すべての受信会話更新アクティビティに対して生成されます。

function onConversationUpdate(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

会話更新アクティビティは、タイトル、参加者、その他のチャネル固有の情報など、会話のメタデータへの変更を記述します。

メンバーが会話に追加または削除されるタイミングを処理するには、onMembersAdded を使用し、onMembersRemoved サブタイプ イベント ハンドラーを します。

ActivityHandler.onConversationUpdate から継承された

受信アクティビティの最後のイベントとして出力される、ダイアログ イベントのアクティビティ イベント ハンドラーを登録します。

function onDialog(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

ActivityHandler.onDialog から継承された

会話 アクティビティの 終了のアクティビティ イベント ハンドラーを登録します。

function onEndOfConversation(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

通常、このアクティビティは、スキルから、その特定の子会話の終了を示すスキル呼び出し元に送信されます。

会話の終了を処理するには、onEndOfConversation 型固有のイベント ハンドラーを使用します。

Inherited From ActivityHandler.onEndOfConversation

すべての受信イベント アクティビティに対して出力される、イベント イベントのアクティビティ イベント ハンドラーを登録します。

function onEvent(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

イベント アクティビティは、クライアントまたはチャネルからボットにプログラム情報を伝達します。 イベント アクティビティの意味は、アクティビティの 名 プロパティによって定義されます。これは、チャネルのスコープ内で意味があります。 イベント アクティビティは、対話型情報 (ボタンクリックなど) と非対話型情報 (埋め込み音声モデルを自動的に更新するクライアントの通知など) の両方を伝達するように設計されています。

tokens/response イベントを処理するには、onTokenResponseEvent サブタイプ イベント ハンドラーを使用します。 他の名前付きイベントを処理するには、このハンドラーにロジックを追加します。

ActivityHandler.onEvent から継承された

installationupdate アクティビティのアクティビティ イベント ハンドラーを登録します。

function onInstallationUpdate(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

InstallationUpdate イベントを処理するには、onInstallationUpdate 型固有のイベント ハンドラーを使用します。

ActivityHandler.onInstallationUpdate から継承された

installationupdate add アクティビティのアクティビティ イベント ハンドラーを登録します。

function onInstallationUpdateAdd(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。 InstallationUpdateAdd イベントを処理するには、onInstallationUpdateAdd 型固有のイベント ハンドラーを使用します。

ActivityHandler.onInstallationUpdateAdd から継承された

installationupdate remove アクティビティのアクティビティ イベント ハンドラーを登録します。

function onInstallationUpdateRemove(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

InstallationUpdateRemove イベントを処理するには、onInstallationUpdateRemove 型固有のイベント ハンドラーを使用します。

ActivityHandler.onInstallationUpdateRemove から継承された

メッセージ交換に追加されたメンバーを含む受信会話更新アクティビティに対して出力される、 イベント メンバーのアクティビティ イベント ハンドラーを登録します。

function onMembersAdded(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

アクティビティの membersAdded プロパティには、会話に追加されたメンバーが含まれます。これにはボットを含めることができます。

会話更新イベントを一般的に処理するには、onConversationUpdate 型固有のイベント ハンドラーを使用します。

ActivityHandler.onMembersAdded から継承された

メッセージ交換から削除されたメンバーを含む受信会話更新アクティビティに対して出力される、イベント 削除された メンバーのアクティビティ イベント ハンドラーを登録します。

function onMembersRemoved(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

アクティビティの membersRemoved プロパティには、会話から削除されたメンバーが含まれます。これにはボットを含めることができます。

会話更新イベントを一般的に処理するには、onConversationUpdate 型固有のイベント ハンドラーを使用します。

ActivityHandler.onMembersRemoved から継承された

すべての受信メッセージ アクティビティに対して出力される メッセージ イベントのアクティビティ イベント ハンドラーを登録します。

function onMessage(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

メッセージ アクティビティは、会話インターフェイス内に表示されることを意図したコンテンツを表し、テキスト、音声、対話型カード、バイナリまたは不明な添付ファイルを含めることができます。 すべてのメッセージ アクティビティにテキストが含まれているわけではありません。アクティビティの テキスト プロパティは、null または undefinedできます。

ActivityHandler.onMessage から継承された

すべての受信メッセージのリアクション アクティビティに対して出力される、メッセージリアクション イベントのアクティビティ イベント ハンドラーを登録します。

function onMessageReaction(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

メッセージ反応アクティビティは、会話内の既存のメッセージ アクティビティに対する社会的相互作用を表します。 元のアクティビティは、メッセージ反応アクティビティの replyToId プロパティによって参照されます。 プロパティからの は、メッセージに反応したユーザーなどの反応のソースを表します。

会話内のメッセージに対してリアクションが追加または削除されるタイミングを処理するには、onReactionsAdded を使用し、onReactionsRemoved サブタイプ イベント ハンドラーを します。

ActivityHandler.onMessageReaction から継承された

メッセージに追加されたリアクションを記述する受信メッセージのリアクション アクティビティに対して出力される、イベント 追加された リアクションのアクティビティ イベント ハンドラーを登録します。

function onReactionsAdded(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

アクティビティの reactionsAdded プロパティには、追加された 1 つ以上のリアクションが含まれます。

メッセージの反応イベントを一般的に処理するには、onMessageReaction 型固有のイベント ハンドラーを使用します。

ActivityHandler.onReactionsAdded から継承された

メッセージから削除されたリアクションを記述する受信メッセージのリアクション アクティビティに対して出力される、イベント 削除された リアクションのアクティビティ イベント ハンドラーを登録します。

function onReactionsRemoved(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

アクティビティの reactionsRemoved プロパティには、削除された 1 つ以上のリアクションが含まれます。

メッセージの反応イベントを一般的に処理するには、onMessageReaction 型固有のイベント ハンドラーを使用します。

ActivityHandler.onReactionsRemoved から継承された

受信 tokens/response イベント アクティビティに対して出力される、tokens-response イベントのアクティビティ イベント ハンドラーを登録します。 これらは、OAuth 認証フローの一部として生成されます。

function onTokenResponseEvent(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

アクティビティの 値 プロパティには、ユーザー トークンが含まれています。

ボットがダイアログ内で OAuthPrompt を使用して認証を処理する場合、ダイアログはこのアクティビティを受け取って認証フローを完了する必要があります。

他の名前付きイベントとイベント イベント全般を処理するには、onEvent 型固有のイベント ハンドラーを使用します。

ActivityHandler.onTokenResponseEvent から継承された

ターン イベントのアクティビティ イベント ハンドラーを登録します。これは、種類に関係なく、すべての受信アクティビティに対して生成されます。

function onTurn(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

ActivityHandler.onTurn から継承された

アクティビティを入力する のアクティビティ イベント ハンドラー 登録します。

function onTyping(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

Typing イベントを処理するには、onTyping 型固有のイベント ハンドラーを使用します。

ActivityHandler.onTyping から継承された

ActivityHandler がイベント ハンドラーを提供しない型を持つ受信アクティビティに対して生成される、認識できないアクティビティの種類 イベントのアクティビティ イベント ハンドラーを登録します。

function onUnrecognizedActivityType(handler: BotHandler): this

パラメーター

戻り値

ActivityHandler オブジェクトへの参照。

注釈

ActivityHandler では、Bot Framework アクティビティ スキーマで定義されているすべてのアクティビティの種類のイベントが定義されているわけではありません。 さらに、チャネルとカスタム アダプターでは、スキーマに含まれていない型で アクティビティ を作成できます。 アクティビティ ハンドラーは、このようなイベントを受信すると、認識されないアクティビティの種類のイベントを出力します。

アクティビティの 型 プロパティには、アクティビティの種類が含まれています。

Inherited From ActivityHandler.onUnrecognizedActivityType

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

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

パラメーター

戻り値

注釈

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

例えば：

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

も参照

• BotFrameworkAdapter.processActivity

activityHandler.run から継承