ActivityHandler Klasse

Wird aufgerufen, wenn der Bot eine Aktion für adaptive Karten gesendet wird.

Wenn die on_invoke_activity-Methode einen Aufruf mit einer Activity.name adaptiveCard/actionempfängt, ruft sie diese Methode auf.

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

Parameter

Gibt zurück

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

async on_conversation_update_activity(turn_context: TurnContext)

Parameter

Gibt zurück

Hinweise

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

• Wenn die Unterhaltungsaktualisierungsaktivität angibt, dass andere Mitglieder als der Bot der Unterhaltung beigetreten sind, ruft sie die on_members_added_activity-Methode auf.
• Wenn die Unterhaltungsaktualisierungsaktivität angibt, dass andere Mitglieder als der Bot die Unterhaltung verlassen, ruft sie die on_members_removed_activity-Methode auf.
• Überschreiben Sie in einer abgeleiteten Klasse diese Methode, um Logik hinzuzufügen, die für alle Unterhaltungsaktualisierungsaktivitäten gilt. Fügen Sie vor dem Aufruf dieser Basisklassenmethode Logik hinzu, die angewendet werden soll, bevor das Element eine Logik hinzugefügt oder entfernt hat.

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

async on_end_of_conversation_activity(turn_context: TurnContext)

Parameter

Gibt zurück

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

async on_event(turn_context: TurnContext)

Parameter

Gibt zurück

Hinweise

Wenn die on_event_activity verwendet wird, empfängt die Methode ein Ereignis mit einem anderen Aktivitätsnamen als Token/Antwort, ruft sie diese Methode auf. Diese Methode kann optional außer Kraft gesetzt werden, wenn der Bot verschiedene Ereignisse behandeln soll.

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

Gibt zurück

Hinweise

Wenn die on_turn-Methode eine Ereignisaktivität empfängt, ruft sie diese Methode auf. Wenn der Aktivitätsname Token/Antwortist, wird on_token_response_eventaufgerufen; andernfalls wird on_eventaufgerufen.

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

Ereignisaktivitäten kommunizieren programmgesteuerte Informationen von einem Client oder Kanal an einen Bot. Die Bedeutung einer Ereignisaktivität wird durch die Eigenschaft "Ereignisaktivitätsname" definiert, die innerhalb des Bereichs eines Kanals aussagekräftig ist.

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

async on_installation_update(turn_context: TurnContext)

Parameter

Gibt zurück

Ü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

Gibt zurück

Ü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

Gibt zurück

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

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

Parameter

Gibt zurück

Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um Logik bereitzustellen, wenn andere Member als der Bot der Unterhaltung beitreten. Sie können die Willkommenslogik Ihres Bots hinzufügen.

Unterhaltungsaktualisierungsaktivität :type members_added: List :p aram turn_context: Das Kontextobjekt für diese Turn:type turn_context: TurnContext

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

Parameter

Gibt zurück

Hinweise

Wenn die on_conversation_update_activity-Methode eine Unterhaltungsaktualisierungsaktivität empfängt, die angibt, dass mindestens ein anderer Benutzer als der Bot an der Unterhaltung teilnimmt, ruft sie diese Methode auf.

Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um Logik bereitzustellen, wenn andere Member als der Bot die Unterhaltung verlassen. Sie können die Gute-Bye-Logik Ihres Bots hinzufügen.

Unterhaltungsaktualisierungsaktivität :type members_added: List :p aram turn_context: Das Kontextobjekt für diese Turn:type turn_context: TurnContext

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

Parameter

Gibt zurück

Hinweise

Wenn die on_conversation_update_activity-Methode eine Unterhaltungsaktualisierungsaktivität empfängt, die angibt, dass mindestens ein anderer Benutzer als der Bot die Unterhaltung verlässt, wird diese Methode aufgerufen.

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

async on_message_activity(turn_context: TurnContext)

Parameter

Gibt zurück

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

Gibt zurück

Hinweise

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

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

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

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

• Wenn die Nachrichtenreaktion angibt, dass Reaktionen aus einer Nachricht entfernt wurden, ruft sie <xref:botbuilder.core.ActivityHandler.on_reaction_removed>auf.

Ü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 Reaktionen vor dem Aufruf der Basisklassenmethode hinzugefügt oder entfernt wurden. Fügen Sie Logik hinzu, die nach dem Aufruf der Basisklassenmethode angewendet werden soll, nachdem die Reaktionen hinzugefügt oder entfernt wurden.

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

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

Parameter

Gibt zurück

Hinweise

Nachrichtenreaktionen entsprechen dem Benutzer, der eine "Gefällt mir" oder "traurig" usw. (oft ein Emoji) zu einer zuvor gesendeten Nachricht in der Unterhaltung hinzufügt. 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 ihm eine ID zu, die in der Ressourcenantwort-ID des Ergebnisses verfügbar ist.

Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um Logik bereitzustellen, wenn Reaktionen auf eine vorherige Aktivität aus der Unterhaltung entfernt werden.

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

Parameter

Gibt zurück

Hinweise

Nachrichtenreaktionen entsprechen dem Benutzer, der eine "Gefällt mir" oder "traurig" usw. (oft ein Emoji) zu einer zuvor gesendeten Nachricht in der Unterhaltung hinzufügt. 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 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 ihm eine ID zu, die in der Ressourcenantwort-ID des Ergebnisses verfügbar ist.

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 weiterzuleiten"/an das aktuelle Dialogfeld. Standardmäßig führt diese Methode nichts aus.

async on_sign_in_invoke(turn_context: TurnContext)

Parameter

Gibt zurück

Wird aufgerufen, wenn ein Token/Antwort- Ereignis empfangen wird, wenn das Basisverhalten von on_event_activity verwendet wird. Wenn Sie eine oauth_promptverwenden, überschreiben Sie diese Methode, um diese Aktivität an das aktuelle Dialogfeld weiterzuleiten.

async on_token_response_event(turn_context: TurnContext)

Parameter

Gibt zurück

Hinweise

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

Wird vom Adapter (z. B. BotFrameworkAdapter) zur Laufzeit aufgerufen, um eine eingehende Activityzu verarbeiten.

async on_turn(turn_context: TurnContext)

Parameter

Gibt zurück

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 von on_turnangewendet werden soll.
• Fügen Sie logik hinzu, die nach dem Aufrufen von on_turnnach der typspezifischen Logik angewendet werden soll.

Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.typing activities, z. B. die Unterhaltungslogik, bereitzustellen.

async on_typing_activity(turn_context: TurnContext)

Parameter

Gibt zurück

Wird aufgerufen, wenn eine andere Aktivität als eine Nachricht, Unterhaltungsaktualisierung oder ein Ereignis empfangen wird, wenn das Basisverhalten von on_turn verwendet wird. Wenn diese Methode außer Kraft gesetzt wird, kann diese Methode möglicherweise auf einen der anderen Aktivitätstypen reagieren.

async on_unrecognized_activity_type(turn_context: TurnContext)

Parameter

Gibt zurück

Hinweise

Wenn die on_turn-Methode eine Aktivität empfängt, die keine Nachricht, Unterhaltungsaktualisierung, Nachrichtenreaktion oder Ereignisaktivität ist, wird diese Methode aufgerufen.