TeamsActivityHandler class

リファレンス

パッケージ:: botbuilder

Microsoft Teams 固有のイベントと操作のサポートを追加します。

Extends: ActivityHandler

注釈

開発者は、次の 2 つの方法を使用して、Microsoft Teams から送信された会話更新アクティビティを処理できます。

で始まりon..、で..Event()終わっていないメソッド (例: onTeamsMembersAdded())、または代わりにメソッドをオーバーライドする
以前の {@see ActivityHandler} 実装に沿った状態を維持するために、で始まり、で...Event() 終on..わるメソッドにコールバックを渡します。 onTeamsMembersAddedEvent()

開発者は、同じアクティビティに対して #2 と #3 の両方ではなく、すべての Conversation Update アクティビティに上記の #1 または #2 を使用する必要があります。つまり、開発者はとの両方onTeamsMembersAdded()onTeamsMembersAddedEvent()をオーバーライドonTeamsMembersAdded()し、使用しないでください。

Invoke アクティビティを処理する開発者は、で始まるhandle...()メソッドをオーバーライドする必要があります (例: handleTeamsTaskModuleFetch())。

メソッド

onTeamsChannelCreatedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	チャネルの作成時など、TeamsChannelCreated イベントのハンドラーを登録します。
onTeamsChannelDeletedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	チャネルが削除されたときなど、TeamsChannelDeleted イベントのハンドラーを登録します。
onTeamsChannelRenamedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	チャネルの名前が変更されたときなど、TeamsChannelRenamed イベントのハンドラーを登録します。
onTeamsChannelRestoredEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	チャネルが復元されたときなど、TeamsChannelRestored イベントのハンドラーを登録します。
onTeamsMeetingEndEvent((meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Teams 会議が終了したときにのハンドラーを登録します。
onTeamsMeetingStartEvent((meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Teams 会議の開始時のハンドラーを登録します。
onTeamsMembersAddedEvent((membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	ボット以外のメンバーがチャネルに参加するタイミング (ボットのウェルカムロジックなど) など、TeamsMembersAdded イベントのハンドラーを登録します。
onTeamsMembersRemovedEvent((membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	ボット以外のメンバーがチャネルを離れる場合 (ボットのさようならロジックなど) など、TeamsMembersRemoved イベントのハンドラーを登録します。
onTeamsReadReceiptEvent((receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	開封確認メッセージが送信されたときにのハンドラーを登録します。
onTeamsTeamArchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	チームがアーカイブされたときなど、TeamsTeamArchived イベントのハンドラーを登録します。
onTeamsTeamDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	チームが削除されたときなど、TeamsTeamDeleted イベントのハンドラーを登録します。
onTeamsTeamHardDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	チームがハード削除されたときなど、TeamsTeamHardDeleted イベントのハンドラーを登録します。
onTeamsTeamRenamedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	TeamsTeamRenamed イベントのハンドラーを登録します(チームの名前が変更されたときなど)。
onTeamsTeamRestoredEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	TeamsTeamRestored イベントのハンドラー (チームが復元されたときなど) を登録します。
onTeamsTeamUnarchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	TeamsTeamUnarchived イベントのハンドラーを登録します (チームがアーカイブされていない場合など)。

継承されたメソッド

onCommand(BotHandler)	コマンドアクティビティのアクティビティイベントハンドラーを登録します。
onCommandResult(BotHandler)	CommandResult アクティビティのアクティビティイベントハンドラーを登録します。
onConversationUpdate(BotHandler)	メッセージ交換更新イベントのアクティビティイベントハンドラーを登録します。これは、受信した会話の更新アクティビティごとに生成されます。
onDialog(BotHandler)	受信アクティビティの最後のイベントとして出力される、ダイアログイベントのアクティビティイベントハンドラーを登録します。
onEndOfConversation(BotHandler)	会話アクティビティの終了に対するアクティビティイベントハンドラーを登録します。
onEvent(BotHandler)	すべての受信イベントアクティビティに対して出力されるイベントイベントのアクティビティイベントハンドラーを登録します。
onInstallationUpdate(BotHandler)	installationupdate アクティビティのアクティビティイベントハンドラーを登録します。
onInstallationUpdateAdd(BotHandler)	installationupdate add アクティビティのアクティビティイベントハンドラーを登録します。
onInstallationUpdateRemove(BotHandler)	installationupdate remove アクティビティのアクティビティイベントハンドラーを登録します。
onMembersAdded(BotHandler)	メッセージ交換に追加されたメンバーを含む受信会話更新アクティビティに対して生成される、追加されたメンバーのアクティビティイベントハンドラーを登録します。
onMembersRemoved(BotHandler)	スレッドから削除されたメンバーを含む受信会話更新アクティビティに対して出力される、削除されたメンバーのアクティビティイベントハンドラーを登録します。
onMessage(BotHandler)	すべての受信メッセージアクティビティに対して出力されるメッセージイベントのアクティビティイベントハンドラーを登録します。
onMessageReaction(BotHandler)	すべての受信メッセージ反応アクティビティに対して出力される、メッセージリアクションイベントのアクティビティイベントハンドラーを登録します。
onReactionsAdded(BotHandler)	メッセージに追加されたリアクションを記述する受信メッセージのリアクションアクティビティに対して出力される、追加されたリアクションイベントのアクティビティイベントハンドラーを登録します。
onReactionsRemoved(BotHandler)	メッセージから削除されたリアクションを記述する受信メッセージのリアクションアクティビティに対して出力される、削除されたリアクションイベントのアクティビティイベントハンドラーを登録します。
onTokenResponseEvent(BotHandler)	受信`tokens/response`イベントアクティビティに対して生成される tokens-response イベントのアクティビティイベントハンドラーを登録します。これらは、OAuth 認証フローの一部として生成されます。
onTurn(BotHandler)	種類に関係なく、すべての受信アクティビティに対して出力されるターンイベントのアクティビティイベントハンドラーを登録します。
onTyping(BotHandler)	入力アクティビティのアクティビティイベントハンドラーを登録します。
onUnrecognizedActivityType(BotHandler)	受信アクティビティに対して生成される、認識できないアクティビティの種類イベントのアクティビティイベントハンドラーを、 ActivityHandler がイベントハンドラーを提供しない型で登録します。
run(TurnContext)	イベントの放出プロセスを開始するために呼び出されます。

メソッドの詳細

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

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

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

パラメーター

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

チームチャネルで作成されたイベントを処理するコールバック。

戻り値

this

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

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

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

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

パラメーター

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

Teams チャネル削除イベントを処理するコールバック。

戻り値

this

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

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

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

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

パラメーター

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

Teams チャネルの名前が変更されたイベントを処理するコールバック。

戻り値

this

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

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

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

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

パラメーター

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

Teams チャネルの復元イベントを処理するためのコールバック。

戻り値

this

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

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

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

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

パラメーター

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

会議終了イベントを処理するコールバック。

戻り値

this

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

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

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

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

パラメーター

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

会議の開始イベントを処理するコールバック。

戻り値

this

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

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

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

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

パラメーター

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

Teams メンバーが追加したイベントを処理するためのコールバック。

戻り値

this

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

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

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

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

パラメーター

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

Teams メンバーが削除したイベントを処理するためのコールバック。

戻り値

this

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

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

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

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

パラメーター

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

開封確認イベントを処理するコールバック。

戻り値

this

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

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

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

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

パラメーター

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

チームチームがアーカイブしたイベントを処理するためのコールバック。

戻り値

this

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

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

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

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

パラメーター

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

チームチームが削除したイベントを処理するためのコールバック。

戻り値

this

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

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

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

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

パラメーター

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

チームチームのハード削除イベントを処理するためのコールバック。

戻り値

this

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

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

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

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

パラメーター

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

チームチームの名前が変更されたイベントを処理するコールバック。

戻り値

this

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

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

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

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

パラメーター

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

チームチームが復元したイベントを処理するためのコールバック。

戻り値

this

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

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

TeamsTeamUnarchived イベントのハンドラーを登録します (チームがアーカイブされていない場合など)。

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

パラメーター

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

チームチームの整理されていないイベントを処理するコールバック。

戻り値

this

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

継承済みメソッドの詳細

onCommand(BotHandler)

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

function onCommand(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

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

継承元 ActivityHandler.onCommand

onCommandResult(BotHandler)

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

function onCommandResult(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

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

継承元 ActivityHandler.onCommandResult

onConversationUpdate(BotHandler)

メッセージ交換更新イベントのアクティビティイベントハンドラーを登録します。これは、受信した会話の更新アクティビティごとに生成されます。

function onConversationUpdate(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

会話更新アクティビティでは、タイトル、参加者、その他のチャネル固有の情報など、会話のメタデータに対する変更について説明します。

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

継承元 ActivityHandler.onConversationUpdate

onDialog(BotHandler)

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

function onDialog(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

継承元 ActivityHandler.onDialog

onEndOfConversation(BotHandler)

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

function onEndOfConversation(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

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

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

継承元 ActivityHandler.onEndOfConversation

onEvent(BotHandler)

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

function onEvent(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

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

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

継承元 ActivityHandler.onEvent

onInstallationUpdate(BotHandler)

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

function onInstallationUpdate(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

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

継承元 ActivityHandler.onInstallationUpdate

onInstallationUpdateAdd(BotHandler)

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

function onInstallationUpdateAdd(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

継承元 ActivityHandler.onInstallationUpdateAdd

onInstallationUpdateRemove(BotHandler)

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

function onInstallationUpdateRemove(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

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

継承元 ActivityHandler.onInstallationUpdateRemove

onMembersAdded(BotHandler)

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

function onMembersAdded(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

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

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

継承元 ActivityHandler.onMembersAdded

onMembersRemoved(BotHandler)

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

function onMembersRemoved(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

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

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

継承元 ActivityHandler.onMembersRemoved

onMessage(BotHandler)

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

function onMessage(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

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

継承元 ActivityHandler.onMessage

onMessageReaction(BotHandler)

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

function onMessageReaction(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

メッセージの反応アクティビティは、会話内の既存のメッセージアクティビティに関するソーシャルインタラクションを表しています。元のアクティビティは、メッセージリアクションアクティビティの replyToId プロパティによって参照されます。 from プロパティは、メッセージに反応したユーザーなどのリアクションのソースを表します。

会話内のメッセージに対する反応の追加または削除を処理するには、 onReactionsAdded および onReactionsRemoved サブタイプイベントハンドラーを使用します。

継承元 ActivityHandler.onMessageReaction

onReactionsAdded(BotHandler)

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

function onReactionsAdded(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

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

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

継承元 ActivityHandler.onReactionsAdded

onReactionsRemoved(BotHandler)

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

function onReactionsRemoved(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

アクティビティの reactionsRemoved プロパティには、除去された 1 つ以上の反応が含まれます。

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

継承元 ActivityHandler.onReactionsRemoved

onTokenResponseEvent(BotHandler)

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

function onTokenResponseEvent(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

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

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

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

継承元 ActivityHandler.onTokenResponseEvent

onTurn(BotHandler)

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

function onTurn(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

継承元 ActivityHandler.onTurn

onTyping(BotHandler)

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

function onTyping(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

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

継承元 ActivityHandler.onTyping

onUnrecognizedActivityType(BotHandler)

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

function onUnrecognizedActivityType(handler: BotHandler): this

パラメーター

handler: BotHandler

イベントハンドラー。

戻り値

this

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

注釈

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

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

継承元 ActivityHandler.onUnrecognizedActivityType

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 bot's activity logic.
         await bot.run(context);
     });
});

参照

BotFrameworkAdapter.processActivity

継承元 ActivityHandler.run