ActivityHandler クラス

ボットがアダプティブ カード アクションの実行を送信されたときに呼び出されます。

on_invoke_activity メソッドは、adaptiveCard/action の Activity.name を持つ Invoke受け取ると、このメソッドを呼び出します。

async on_adaptive_card_invoke(turn_context: TurnContext, invoke_value: AdaptiveCardInvokeValue) -> AdaptiveCardInvokeResponse

パラメーター

戻り値

on_turn の基本動作が使用されるときに、チャネルから会話更新アクティビティを受信したときに呼び出されます。

async on_conversation_update_activity(turn_context: TurnContext)

パラメーター

戻り値

注釈

on_turn メソッドは、会話更新アクティビティを受け取ると、このメソッドを呼び出します。 また

• 会話の更新アクティビティが、ボット以外のメンバーが会話に参加したことを示す場合は、on_members_added_activity メソッドを呼び出します。
• 会話の更新アクティビティが、ボット以外のメンバーが会話を離れたことを示している場合は、on_members_removed_activity メソッドを呼び出します。
• 派生クラスで、このメソッドをオーバーライドして、すべての会話更新アクティビティに適用されるロジックを追加します。 メンバーがこの基底クラス メソッドの呼び出しの前にロジックを追加または削除する前に適用するロジックを追加します。

会話の終了アクティビティがチャネルから受信されたときに呼び出されます。

async on_end_of_conversation_activity(turn_context: TurnContext)

パラメーター

戻り値

の基本動作が使用されたときに、on_event_activity 以外のイベントが受信されたときに呼び出されます。

async on_event(turn_context: TurnContext)

パラメーター

戻り値

注釈

on_event_activity が使用されるメソッドは、トークン/応答以外のアクティビティ名を持つイベントを受け取ると、このメソッドを呼び出します。 ボットが他のイベントを処理することを意図している場合は、必要に応じてこのメソッドをオーバーライドできます。

on_turn の基本動作が使用されるときに、コネクタからイベント アクティビティを受信したときに呼び出されます。

async on_event_activity(turn_context: TurnContext)

パラメーター

戻り値

注釈

on_turn メソッドは、イベント アクティビティを受信すると、このメソッドを呼び出します。 アクティビティ名がトークン/応答 場合は、on_token_response_eventを呼び出します。それ以外の場合は、on_eventを呼び出します。

派生クラスで、このメソッドをオーバーライドして、すべてのイベント アクティビティに適用されるロジックを追加します。 この基底クラス メソッドの呼び出しの前に、特定のイベント処理ロジックの前に適用するロジックを追加します。 この基底クラス メソッドの呼び出しの後に、特定のイベント処理ロジックの後に適用するロジックを追加します。

イベント アクティビティは、クライアントまたはチャネルからボットにプログラム情報を伝達します。 イベント アクティビティの意味は、チャネルのスコープ内で意味のあるイベント アクティビティ名プロパティによって定義されます。

ActivityTypes.InstallationUpdate アクティビティに固有のロジックを提供するには、派生クラスでこれをオーバーライドします。

async on_installation_update(turn_context: TurnContext)

パラメーター

戻り値

'action' が 'add' に設定された ActivityTypes.InstallationUpdate アクティビティに固有のロジックを提供するには、派生クラスでこれをオーバーライドします。

async on_installation_update_add(turn_context: TurnContext)

パラメーター

戻り値

'action' が 'remove' に設定された ActivityTypes.InstallationUpdate アクティビティに固有のロジックを提供するには、派生クラスでこれをオーバーライドします。

async on_installation_update_remove(turn_context: TurnContext)

パラメーター

戻り値

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

async on_invoke_activity(turn_context: TurnContext) -> InvokeResponse | None

パラメーター

戻り値

ボット以外のメンバーが会話に参加する場合のロジックを提供するには、派生クラスでこのメソッドをオーバーライドします。 ボットのウェルカム ロジックを追加できます。

conversation update activity :type members_added: List :p aram turn_context: このターンのコンテキスト オブジェクト :type turn_context: TurnContext

async on_members_added_activity(members_added: List[ChannelAccount], turn_context: TurnContext)

パラメーター

戻り値

注釈

on_conversation_update_activity メソッドは、ボット以外の 1 人以上のユーザーが会話に参加していることを示す会話更新アクティビティを受信すると、このメソッドを呼び出します。

ボット以外のメンバーが会話を離れたときのロジックを提供するには、派生クラスでこのメソッドをオーバーライドします。 ボットのさよならロジックを追加できます。

conversation update activity :type members_added: List :p aram turn_context: このターンのコンテキスト オブジェクト :type turn_context: TurnContext

async on_members_removed_activity(members_removed: List[ChannelAccount], turn_context: TurnContext)

パラメーター

戻り値

注釈

on_conversation_update_activity メソッドは、ボット以外の 1 人以上のユーザーが会話から離れることを示す会話更新アクティビティを受け取ると、このメソッドを呼び出します。

対話型ロジックなどのアクティビティに固有のロジックを提供するには、派生クラスでこのメソッドをオーバーライドします。

async on_message_activity(turn_context: TurnContext)

パラメーター

戻り値

on_turn の基本動作が使用されるときに、コネクタからイベント アクティビティを受信したときに呼び出されます。

async on_message_reaction_activity(turn_context: TurnContext)

パラメーター

戻り値

注釈

メッセージの反応は、以前に送信されたアクティビティに "いいね" や "sad" などの (多くの場合絵文字) を追加するユーザーに対応します。

メッセージの反応は、少数のチャネルでのみサポートされます。 メッセージの反応が対応するアクティビティは、Id プロパティへの応答で示されます。 このプロパティの値は、送信呼び出しからの応答としてボットに返された、以前に送信されたアクティビティのアクティビティ ID です。 on_turn メソッドは、メッセージの反応アクティビティを受け取ると、このメソッドを呼び出します。

• メッセージのリアクションがメッセージに追加されたことを示す場合は、

<xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_added>.

• メッセージの反応がメッセージから削除されたことを示す場合は、<xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_removed>を呼び出します。

派生クラスで、このメソッドをオーバーライドして、すべてのメッセージ反応アクティビティに適用されるロジックを追加します。 この基底クラス メソッドの呼び出しの前に、リアクションによってロジックが追加または削除される前に適用するロジックを追加します。 この基底クラス メソッドの呼び出し後に、リアクションの追加または削除されたロジックの後に適用するロジックを追加します。

前のアクティビティへの反応が会話に追加されるタイミングのロジックを提供するには、派生クラスでこのメソッドをオーバーライドします。

async on_reactions_added(message_reactions: List[MessageReaction], turn_context: TurnContext)

パラメーター

戻り値

注釈

メッセージの反応は、会話で以前に送信されたメッセージに "いいね" や "sad" などの文字 (多くの場合は絵文字) を追加するユーザーに対応します。 メッセージの反応は、少数のチャネルでのみサポートされます。 メッセージが反応しているアクティビティは、アクティビティの ID プロパティへの応答によって識別されます。 このプロパティの値は、以前に送信されたアクティビティのアクティビティ ID です。 ボットがアクティビティを送信すると、チャネルによって ID が割り当てられます。ID は、結果のリソース応答 ID で使用できます。

前のアクティビティへの反応が会話から削除されるタイミングのロジックを提供するには、派生クラスでこのメソッドをオーバーライドします。

async on_reactions_removed(message_reactions: List[MessageReaction], turn_context: TurnContext)

パラメーター

戻り値

注釈

メッセージの反応は、会話で以前に送信されたメッセージに "いいね" や "sad" などの文字 (多くの場合は絵文字) を追加するユーザーに対応します。 メッセージの反応は、少数のチャネルでのみサポートされます。 メッセージが応答しているアクティビティは、アクティビティの Id プロパティへの応答によって識別されます。 このプロパティの値は、以前に送信されたアクティビティのアクティビティ ID です。 ボットがアクティビティを送信すると、チャネルによって ID が割り当てられます。ID は、結果のリソース応答 ID で使用できます。

on_invoke_activity(TurnContext{InvokeActivity}) の基本動作が使用されたときに、signin/verifyState または signin/tokenExchange イベントを受信したときに呼び出されます。 OAuthPrompt を使用している場合は、このメソッドをオーバーライドして、このアクティビティ"/ を現在のダイアログに転送します。 既定では、このメソッドは何も行いません。

async on_sign_in_invoke(turn_context: TurnContext)

パラメーター

戻り値

の基本動作が使用されたときに、on_event_activity イベントが受信されたときに呼び出されます。 oauth_promptを使用している場合は、このメソッドをオーバーライドして、このアクティビティを現在のダイアログに転送します。

async on_token_response_event(turn_context: TurnContext)

パラメーター

戻り値

注釈

on_event メソッドは、トークン/応答のアクティビティ名を持つイベントを受け取ると、このメソッドを呼び出します。 ボットで oauth_promptを使用している場合は、受信アクティビティを現在のダイアログに転送します。

受信 <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>を処理するために、実行時にアダプター (Activityなど) によって呼び出されます。

async on_turn(turn_context: TurnContext)

パラメーター

戻り値

注釈

このクラスの他のメソッドは、処理するアクティビティの型に基づいて呼び出されます。これにより、派生クラスは、制御された方法で型固有のロジックを提供できます。 派生クラスで、このメソッドをオーバーライドして、すべてのアクティビティの種類に適用されるロジックを追加します。 また

• 型固有のロジックの前と、on_turnを呼び出す前に適用するロジックを追加します。
• on_turnを呼び出した後、型固有のロジックの後に適用するロジックを追加します。

これを派生クラスでオーバーライドして、ActivityTypes.typing アクティビティに固有のロジック (会話ロジックなど) を提供します。

async on_typing_activity(turn_context: TurnContext)

パラメーター

戻り値

on_turn の基本動作が使用されたときに、メッセージ、会話の更新、またはイベント以外のアクティビティを受信したときに呼び出されます。 オーバーライドされた場合、このメソッドは他のアクティビティの種類のいずれかに応答する可能性があります。

async on_unrecognized_activity_type(turn_context: TurnContext)

パラメーター

戻り値

注釈

on_turn メソッドは、メッセージ、会話の更新、メッセージの反応、またはイベント アクティビティではないアクティビティを受信すると、このメソッドを呼び出します。