ActivityHandler Klasse

Verarbeitet Aktivitäten und sollte unterklassiert werden.

Vererbung

Bot

ActivityHandler

Konstruktor

ActivityHandler()

Hinweise

Leiten Sie von dieser Klasse ab, um bestimmte Aktivitätstypen zu behandeln. Yon kann die Vor- und Nachverarbeitung von Aktivitäten hinzufügen, indem die Basisklasse in der abgeleiteten Klasse aufgerufen wird.

Methoden

on_adaptive_card_invoke	Wird aufgerufen, wenn dem Bot eine Adaptive Card Action Execute gesendet wird. Wenn die on_invoke_activity-Methode einen Invoke-Wert mit dem Activity.name adaptiveCard/action empfängt, ruft sie diese Methode auf.
on_conversation_update_activity	Wird aufgerufen, wenn eine Konversationsaktualisierungsaktivität vom Kanal empfangen wird, wenn das Basisverhalten von on_turn verwendet wird.
on_end_of_conversation_activity	Wird aufgerufen, wenn eine Konversationsendaktivität vom Kanal empfangen wird.
on_event	Wird aufgerufen, wenn ein anderes Ereignis als Token/Antwort empfangen wird, wenn das Basisverhalten von on_event_activity verwendet wird.
on_event_activity	Wird aufgerufen, wenn eine Ereignisaktivität vom Connector empfangen wird, wenn das Basisverhalten von on_turn verwendet wird.
on_installation_update	Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.InstallationUpdate-Aktivitäten bereitzustellen.
on_installation_update_add	Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.InstallationUpdate-Aktivitäten bereitzustellen, wobei "action" auf "add" festgelegt ist.
on_installation_update_remove	Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.InstallationUpdate-Aktivitäten bereitzustellen, wobei "action" auf "remove" festgelegt ist.
on_invoke_activity	Registriert einen Aktivitätsereignishandler für das Aufrufereignis , das für jede eingehende Ereignisaktivität ausgegeben wird.
on_members_added_activity	Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um Logik für den Fall bereitzustellen, dass andere Member als der Bot der Konversation beitreten. Sie können die Willkommenslogik Ihres Bots hinzufügen. Conversation Update-Aktivität :type members_added: List :p aram turn_context: Das Kontextobjekt für diesen Turn :type turn_context: TurnContext
on_members_removed_activity	Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um Logik dafür bereitzustellen, wenn andere Member als der Bot die Konversation verlassen. Sie können die Good-bye-Logik Ihres Bots hinzufügen. Conversation Update-Aktivität :type members_added: List :p aram turn_context: Das Kontextobjekt für diesen Turn :type turn_context: TurnContext
on_message_activity	Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um spezifische Logik für Aktivitäten bereitzustellen, z. B. die Unterhaltungslogik.
on_message_reaction_activity	Wird aufgerufen, wenn eine Ereignisaktivität vom Connector empfangen wird, wenn das Basisverhalten von on_turn verwendet wird.
on_reactions_added	Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um Logik dafür bereitzustellen, wenn der Konversation Reaktionen auf eine vorherige Aktivität hinzugefügt werden.
on_reactions_removed	Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um Logik für den Fall bereitzustellen, dass Reaktionen auf eine vorherige Aktivität aus der Konversation entfernt werden.
on_sign_in_invoke	Wird aufgerufen, wenn ein signin/verifyState- oder signin/tokenExchange-Ereignis empfangen wird, wenn das Basisverhalten von on_invoke_activity(TurnContext{InvokeActivity}) verwendet wird. Wenn Sie eine OAuthPrompt verwenden, überschreiben Sie diese Methode, um diese Aktivität"/ an das aktuelle Dialogfeld weiterzuleiten. Standardmäßig hat diese Methode keine Auswirkungen.
on_token_response_event	Wird aufgerufen, wenn ein Token-/Antwortereignis empfangen wird, wenn das Basisverhalten von on_event_activity verwendet wird. Wenn Sie einen oauth_prompt verwenden, überschreiben Sie diese Methode, um diese Aktivität an das aktuelle Dialogfeld weiterzuleiten.
on_turn	Wird vom Adapter (z. B. ) zur Laufzeit aufgerufen, <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>um einen eingehenden Activityzu verarbeiten.
on_typing_activity	Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.typing-Aktivitäten wie die Unterhaltungslogik bereitzustellen.
on_unrecognized_activity_type	Wird aufgerufen, wenn eine andere Aktivität als eine Nachricht, ein Unterhaltungsupdate oder ein Ereignis empfangen wird, wenn das Basisverhalten von on_turn verwendet wird. Wenn sie überschrieben wird, kann diese Methode möglicherweise auf einen der anderen Aktivitätstypen reagieren.

on_adaptive_card_invoke

Wird aufgerufen, wenn dem Bot eine Adaptive Card Action Execute gesendet wird.

Wenn die on_invoke_activity-Methode einen Invoke-Wert mit dem Activity.name adaptiveCard/action empfängt, ruft sie diese Methode auf.

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

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Ein Kontextobjekt für diesen Turn.
invoke_value Erforderlich	<xref:botframework.schema.models.AdaptiveCardInvokeValue> Ein Zeichenfolgentypobjekt aus dem Wert der eingehenden Aktivität.

Gibt zurück

Typ	Beschreibung
	Das HealthCheckResponse-Objekt

on_conversation_update_activity

Wird aufgerufen, wenn eine Konversationsaktualisierungsaktivität vom Kanal empfangen wird, wenn das Basisverhalten von on_turn verwendet wird.

async on_conversation_update_activity(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

Hinweise

Wenn die on_turn Methode eine Konversationsaktualisierungsaktivität empfängt, ruft sie diese Methode auf. Auch

• Wenn die Unterhaltungsaktualisierungsaktivität angibt, dass andere Mitglieder als der Bot der Konversation beigetreten sind, wird die on_members_added_activity -Methode aufgerufen.
• Wenn die Unterhaltungsaktualisierungsaktivität angibt, dass andere Mitglieder als der Bot die Unterhaltung verlassen haben, wird die on_members_removed_activity -Methode aufgerufen.
• Überschreiben Sie in einer abgeleiteten Klasse diese Methode, um Logik hinzuzufügen, die für alle Aktivitäten zur Aktualisierung von Unterhaltungen gilt. Fügen Sie Logik hinzu, die angewendet werden soll, bevor der Member Logik vor dem Aufruf dieser Basisklassenmethode hinzugefügt oder entfernt hat.

on_end_of_conversation_activity

Wird aufgerufen, wenn eine Konversationsendaktivität vom Kanal empfangen wird.

async on_end_of_conversation_activity(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

on_event

Wird aufgerufen, wenn ein anderes Ereignis als Token/Antwort empfangen wird, wenn das Basisverhalten von on_event_activity verwendet wird.

async on_event(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

Hinweise

Wenn die on_event_activity -Methode verwendet wird, ein Ereignis mit einem anderen Aktivitätsnamen als Token/Antwort empfängt, ruft sie diese Methode auf. Diese Methode kann optional überschrieben werden, wenn der Bot verschiedene Ereignisse verarbeiten soll.

on_event_activity

Wird aufgerufen, wenn eine Ereignisaktivität vom Connector empfangen wird, wenn das Basisverhalten von on_turn verwendet wird.

async on_event_activity(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

Hinweise

Wenn die on_turn Methode eine Ereignisaktivität empfängt, ruft sie diese Methode auf. Wenn der Aktivitätsname Token/Antwort ist, wird aufgerufen on_token_response_event, andernfalls wird aufgerufen on_event.

Überschreiben Sie in einer abgeleiteten Klasse diese Methode, um Logik hinzuzufügen, die für alle Ereignisaktivitäten gilt. Fügen Sie Logik hinzu, die vor der spezifischen Ereignisbehandlungslogik vor dem Aufruf dieser Basisklassenmethode angewendet werden soll. Fügen Sie Logik hinzu, die nach der spezifischen Ereignisbehandlungslogik nach dem Aufruf dieser Basisklassenmethode angewendet werden soll.

Ereignisaktivitäten (event) kommunizieren programmgesteuerte Informationen von einem Client oder Kanal an einen Bot. Die Bedeutung einer Ereignisaktivität wird durch die Eigenschaft namens der Ereignisaktivität definiert, die im Bereich eines Kanals sinnvoll ist.

on_installation_update

Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.InstallationUpdate-Aktivitäten bereitzustellen.

async on_installation_update(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

on_installation_update_add

Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.InstallationUpdate-Aktivitäten bereitzustellen, wobei "action" auf "add" festgelegt ist.

async on_installation_update_add(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

on_installation_update_remove

Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.InstallationUpdate-Aktivitäten bereitzustellen, wobei "action" auf "remove" festgelegt ist.

async on_installation_update_remove(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

on_invoke_activity

Registriert einen Aktivitätsereignishandler für das Aufrufereignis , das für jede eingehende Ereignisaktivität ausgegeben wird.

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

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

on_members_added_activity

Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um Logik für den Fall bereitzustellen, dass andere Member als der Bot der Konversation beitreten. Sie können die Willkommenslogik Ihres Bots hinzufügen.

Conversation Update-Aktivität :type members_added: List :p aram turn_context: Das Kontextobjekt für diesen Turn :type turn_context: TurnContext

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

Parameter

Name	Beschreibung
members_added Erforderlich
turn_context Erforderlich

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

Hinweise

Wenn die Methode eine Aktualisierungsaktivität empfängt on_conversation_update_activity , die angibt, dass mindestens ein anderer Benutzer als der Bot an der Unterhaltung teilnimmt, wird diese Methode aufgerufen.

on_members_removed_activity

Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um Logik dafür bereitzustellen, wenn andere Member als der Bot die Konversation verlassen. Sie können die Good-bye-Logik Ihres Bots hinzufügen.

Conversation Update-Aktivität :type members_added: List :p aram turn_context: Das Kontextobjekt für diesen Turn :type turn_context: TurnContext

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

Parameter

Name	Beschreibung
members_removed Erforderlich
turn_context Erforderlich

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

Hinweise

Wenn die -Methode eine Aktivität zum Aktualisieren von on_conversation_update_activity Unterhaltungen empfängt, die angibt, dass mindestens ein anderer Benutzer als der Bot die Konversation verlässt, wird diese Methode aufgerufen.

on_message_activity

Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um spezifische Logik für Aktivitäten bereitzustellen, z. B. die Unterhaltungslogik.

async on_message_activity(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

on_message_reaction_activity

Wird aufgerufen, wenn eine Ereignisaktivität vom Connector empfangen wird, wenn das Basisverhalten von on_turn verwendet wird.

async on_message_reaction_activity(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

Hinweise

Nachrichtenreaktionen entsprechen dem Benutzer, der einer zuvor gesendeten Aktivität ein "Gefällt mir" oder "Traurig" usw. (oft ein Emoji) hinzufügt.

Nachrichtenreaktionen werden nur von wenigen Kanälen unterstützt. Die Aktivität, der die Nachrichtenreaktion entspricht, wird in der Antwort auf id-Eigenschaft angegeben. Der Wert dieser Eigenschaft ist die Aktivitäts-ID einer zuvor gesendeten Aktivität, die an den Bot als Antwort eines Sendeaufrufs zurückgegeben wurde. Wenn die on_turn Methode eine Nachrichtenreaktionsaktivität empfängt, ruft sie diese Methode auf.

• Wenn die Nachrichtenreaktion angibt, dass einer Nachricht Reaktionen hinzugefügt wurden, wird aufgerufen.

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

• Wenn die Nachrichtenreaktion angibt, dass Reaktionen aus einer Nachricht entfernt wurden, wird aufgerufen <xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_removed>.

Überschreiben Sie in einer abgeleiteten Klasse diese Methode, um Logik hinzuzufügen, die für alle Nachrichtenreaktionsaktivitäten gilt. Fügen Sie Logik hinzu, die angewendet werden soll, bevor die Reaktionslogik vor dem Aufruf der Basisklassenmethode hinzugefügt oder entfernt wurde. Fügen Sie Logik hinzu, die angewendet werden soll, nachdem die Reaktionslogik nach dem Aufruf der Methode dieser Basisklasse hinzugefügt oder entfernt wurde.

on_reactions_added

Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um Logik dafür bereitzustellen, wenn der Konversation Reaktionen auf eine vorherige Aktivität hinzugefügt werden.

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

Parameter

Name	Beschreibung
message_reactions Erforderlich	List Die Liste der hinzugefügten Reaktionen
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

Hinweise

Nachrichtenreaktionen entsprechen dem Hinzufügen von "Gefällt mir" oder "Traurig" usw. (oft ein Emoji) zu einer zuvor gesendeten Nachricht in der Unterhaltung. Nachrichtenreaktionen werden nur von wenigen Kanälen unterstützt. Die Aktivität, auf die die Nachricht reagiert, wird durch die Antwort der Aktivität auf die ID-Eigenschaft identifiziert. Der Wert dieser Eigenschaft ist die Aktivitäts-ID einer zuvor gesendeten Aktivität. Wenn der Bot eine Aktivität sendet, weist der Kanal ihr eine ID zu, die in der Ressourcenantwort-ID des Ergebnisses verfügbar ist.

on_reactions_removed

Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um Logik für den Fall bereitzustellen, dass Reaktionen auf eine vorherige Aktivität aus der Konversation entfernt werden.

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

Parameter

Name	Beschreibung
message_reactions Erforderlich	List Die Liste der entfernten Reaktionen
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

Hinweise

Nachrichtenreaktionen entsprechen dem Hinzufügen von "Gefällt mir" oder "Traurig" usw. (oft ein Emoji) zu einer zuvor gesendeten Nachricht in der Unterhaltung. Nachrichtenreaktionen werden nur von wenigen Kanälen unterstützt. Die Aktivität, auf die die Nachricht reagiert, wird durch die Antwort der Aktivität auf die Id-Eigenschaft identifiziert. Der Wert dieser Eigenschaft ist die Aktivitäts-ID einer zuvor gesendeten Aktivität. Wenn der Bot eine Aktivität sendet, weist der Kanal ihr eine ID zu, die in der Ressourcenantwort-ID des Ergebnisses verfügbar ist.

on_sign_in_invoke

Wird aufgerufen, wenn ein signin/verifyState- oder signin/tokenExchange-Ereignis empfangen wird, wenn das Basisverhalten von on_invoke_activity(TurnContext{InvokeActivity}) verwendet wird. Wenn Sie eine OAuthPrompt verwenden, überschreiben Sie diese Methode, um diese Aktivität"/ an das aktuelle Dialogfeld weiterzuleiten. Standardmäßig hat diese Methode keine Auswirkungen.

async on_sign_in_invoke(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

on_token_response_event

Wird aufgerufen, wenn ein Token-/Antwortereignis empfangen wird, wenn das Basisverhalten von on_event_activity verwendet wird. Wenn Sie einen oauth_prompt verwenden, überschreiben Sie diese Methode, um diese Aktivität an das aktuelle Dialogfeld weiterzuleiten.

async on_token_response_event(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

Hinweise

Wenn die on_event Methode ein Ereignis mit dem Aktivitätsnamen Token/Antwort empfängt, ruft sie diese Methode auf. Wenn Ihr Bot eine oauth_prompt verwendet, leiten Sie die eingehende Aktivität an das aktuelle Dialogfeld weiter.

on_turn

Wird vom Adapter (z. B. ) zur Laufzeit aufgerufen, <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>um einen eingehenden Activityzu verarbeiten.

async on_turn(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt

Hinweise

Es ruft andere Methoden in dieser Klasse basierend auf dem Typ der zu verarbeitenden Aktivität auf, wodurch eine abgeleitete Klasse typspezifische Logik auf kontrollierte Weise bereitstellen kann. Überschreiben Sie in einer abgeleiteten Klasse diese Methode, um Logik hinzuzufügen, die für alle Aktivitätstypen gilt. Auch

• Fügen Sie Logik hinzu, die vor der typspezifischen Logik und vor dem Aufrufen on_turnangewendet werden soll.
• Fügen Sie Logik hinzu, die nach der typspezifischen Logik angewendet werden soll, nachdem Sie aufgerufen haben on_turn.

on_typing_activity

Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.typing-Aktivitäten wie die Unterhaltungslogik bereitzustellen.

async on_typing_activity(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt

on_unrecognized_activity_type

Wird aufgerufen, wenn eine andere Aktivität als eine Nachricht, ein Unterhaltungsupdate oder ein Ereignis empfangen wird, wenn das Basisverhalten von on_turn verwendet wird. Wenn sie überschrieben wird, kann diese Methode möglicherweise auf einen der anderen Aktivitätstypen reagieren.

async on_unrecognized_activity_type(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diesen Turn

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt

Hinweise

Wenn die Methode eine Aktivität empfängt, bei der on_turn es sich nicht um eine Nachrichten-, Unterhaltungsaktualisierung, Nachrichtenreaktion oder Ereignisaktivität handelt, ruft sie diese Methode auf.