ActivityHandler クラス

アクティビティを処理し、サブクラス化する必要があります。

継承

Bot

ActivityHandler

コンストラクター

ActivityHandler()

注釈

特定のアクティビティの種類を処理するには、このクラスから派生します。 Yon は、派生クラスの基底クラスを呼び出すことによって、アクティビティの前処理と後処理を追加できます。

メソッド

on_adaptive_card_invoke	ボットがアダプティブ カード アクション実行を送信したときに呼び出されます。 on_invoke_activity メソッドは、 adaptiveCard/action の Activity.name を使用して Invoke を受け取ると、このメソッドを呼び出します。
on_conversation_update_activity	の基本動作 on_turn が使用されている場合に、チャネルから会話更新アクティビティを受信したときに呼び出されます。
on_end_of_conversation_activity	会話の終了アクティビティがチャネルから受信されたときに呼び出されます。
on_event	の基本動作が使用されるときに 、トークン/応答 以外の on_event_activity イベントを受信したときに呼び出されます。
on_event_activity	の基本動作 on_turn が使用されている場合に、コネクタからイベント アクティビティを受信したときに呼び出されます。
on_installation_update	ActivityTypes.InstallationUpdate アクティビティに固有のロジックを提供するには、派生クラスでこれをオーバーライドします。
on_installation_update_add	'action' が 'add' に設定された ActivityTypes.InstallationUpdate アクティビティに固有のロジックを提供するには、派生クラスでこれをオーバーライドします。
on_installation_update_remove	'action' が 'remove' に設定された ActivityTypes.InstallationUpdate アクティビティに固有のロジックを提供するには、派生クラスでこれをオーバーライドします。
on_invoke_activity	すべての受信イベント アクティビティに対して生成される 、呼び出し イベントのアクティビティ イベント ハンドラーを登録します。
on_members_added_activity	ボット以外のメンバーが会話に参加する場合のロジックを提供するには、派生クラスでこのメソッドをオーバーライドします。 ボットのウェルカム ロジックを追加できます。 conversation update activity :type members_added: List :p aram turn_context: このターンのコンテキスト オブジェクト:type turn_context: TurnContext
on_members_removed_activity	ボット以外のメンバーが会話を離れたときのロジックを提供するには、派生クラスでこのメソッドをオーバーライドします。 ボットのさよならロジックを追加できます。 conversation update activity :type members_added: List :p aram turn_context: このターンのコンテキスト オブジェクト:type turn_context: TurnContext
on_message_activity	会話ロジックなどのアクティビティに固有のロジックを提供するには、派生クラスでこのメソッドをオーバーライドします。
on_message_reaction_activity	の基本動作 on_turn が使用されている場合に、コネクタからイベント アクティビティを受信したときに呼び出されます。
on_reactions_added	派生クラスでこのメソッドをオーバーライドして、前のアクティビティへの反応が会話に追加されるタイミングのロジックを提供します。
on_reactions_removed	派生クラスでこのメソッドをオーバーライドして、以前のアクティビティへの反応が会話から削除されたときのロジックを提供します。
on_sign_in_invoke	on_invoke_activity(TurnContext{InvokeActivity}) の基本動作が使用されている場合に、signin/verifyState または signin/tokenExchange イベントを受信したときに呼び出されます。 OAuthPrompt を使用している場合は、このメソッドをオーバーライドして、このアクティビティ"/ を現在のダイアログに転送します。 既定では、このメソッドは何も実行しません。
on_token_response_event	の基本動作on_event_activityが使用されたときにトークン/応答イベントを受信したときに呼び出されます。 oauth_promptを使用している場合は、このメソッドをオーバーライドして、このアクティビティを現在のダイアログに転送します。
on_turn	受信 を処理するために、実行時にアダプターによって呼び出されます Activity(例: BotFrameworkAdapter)。
on_typing_activity	会話ロジックなど、ActivityTypes.typing アクティビティに固有のロジックを提供するには、派生クラスでこれをオーバーライドします。
on_unrecognized_activity_type	の基本動作が使用されるときに、メッセージ、会話の更新、またはイベント以外の on_turn アクティビティを受信したときに呼び出されます。 オーバーライドされた場合、このメソッドは他のアクティビティの種類のいずれかに応答する可能性があります。

on_adaptive_card_invoke

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

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

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

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト。
invoke_value 必須	<xref:botframework.schema.models.AdaptiveCardInvokeValue> 受信アクティビティの値から文字列型のオブジェクト。

戻り値

型	説明
	HealthCheckResponse オブジェクト

on_conversation_update_activity

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

async on_conversation_update_activity(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

注釈

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

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

on_end_of_conversation_activity

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

async on_end_of_conversation_activity(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

on_event

の基本動作が使用されるときに 、トークン/応答 以外の on_event_activity イベントを受信したときに呼び出されます。

async on_event(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

注釈

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

on_event_activity

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

async on_event_activity(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

注釈

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

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

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

on_installation_update

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

async on_installation_update(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

on_installation_update_add

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

async on_installation_update_add(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

on_installation_update_remove

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

async on_installation_update_remove(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

on_invoke_activity

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

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

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

on_members_added_activity

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

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)

パラメーター

名前	説明
members_added 必須
turn_context 必須

戻り値

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

注釈

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

on_members_removed_activity

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

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)

パラメーター

名前	説明
members_removed 必須
turn_context 必須

戻り値

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

注釈

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

on_message_activity

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

async on_message_activity(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

on_message_reaction_activity

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

async on_message_reaction_activity(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

注釈

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

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

• メッセージの反応がメッセージに追加されたことを示す場合は、 を呼び出します。

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

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

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

on_reactions_added

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

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

パラメーター

名前	説明
message_reactions 必須	List 追加されたリアクションの一覧
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

注釈

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

on_reactions_removed

派生クラスでこのメソッドをオーバーライドして、以前のアクティビティへの反応が会話から削除されたときのロジックを提供します。

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

パラメーター

名前	説明
message_reactions 必須	List 削除されたリアクションの一覧
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

注釈

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

on_sign_in_invoke

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

async on_sign_in_invoke(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

on_token_response_event

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

async on_token_response_event(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

注釈

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

on_turn

受信 を処理するために、実行時にアダプターによって呼び出されます Activity(例: BotFrameworkAdapter)。

async on_turn(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

注釈

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

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

on_typing_activity

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

async on_typing_activity(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

on_unrecognized_activity_type

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

async on_unrecognized_activity_type(turn_context: TurnContext)

パラメーター

名前	説明
turn_context 必須	TurnContext このターンのコンテキスト オブジェクト

戻り値

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

注釈

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