ActivityHandler Classe

Appelée lorsque le bot reçoit une action de carte adaptative Execute.

Lorsque la méthode on_invoke_activity reçoit un Invoke avec un Activity.name d’adaptiveCard/action, elle appelle cette méthode.

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

Paramètres

Retours

Appelé lorsqu’une activité de mise à jour de conversation est reçue du canal lorsque le comportement de base de on_turn est utilisé.

async on_conversation_update_activity(turn_context: TurnContext)

Paramètres

Retours

Remarques

Lorsque la on_turn méthode reçoit une activité de mise à jour de conversation, elle appelle cette méthode. Également

• Si l’activité de mise à jour de conversation indique que des membres autres que le bot ont rejoint la conversation, elle appelle la on_members_added_activity méthode .
• Si l’activité de mise à jour de conversation indique que des membres autres que le bot ont quitté la conversation, elle appelle la on_members_removed_activity méthode .
• Dans une classe dérivée, remplacez cette méthode pour ajouter une logique qui s’applique à toutes les activités de mise à jour de conversation. Ajoutez la logique à appliquer avant que le membre n’ajoute ou supprime la logique avant l’appel à cette méthode de classe de base.

Appelé lorsqu’une activité de fin de conversation est reçue du canal.

async on_end_of_conversation_activity(turn_context: TurnContext)

Paramètres

Retours

Appelé lorsqu’un événement autre que jetons/réponse est reçu lorsque le comportement de base de on_event_activity est utilisé.

async on_event(turn_context: TurnContext)

Paramètres

Retours

Remarques

Lorsque la on_event_activity méthode est utilisée reçoit un événement avec un nom d’activité autre que jetons/réponse, elle appelle cette méthode. Cette méthode peut éventuellement être remplacée si le bot est destiné à gérer des événements divers.

Appelé lorsqu’une activité d’événement est reçue du connecteur lorsque le comportement de base de on_turn est utilisé.

async on_event_activity(turn_context: TurnContext)

Paramètres

Retours

Remarques

Lorsque la on_turn méthode reçoit une activité d’événement, elle appelle cette méthode. Si le nom de l’activité est jetons/réponse, elle appelle on_token_response_event; sinon, elle appelle on_event.

Dans une classe dérivée, remplacez cette méthode pour ajouter une logique qui s’applique à toutes les activités d’événement. Ajoutez la logique à appliquer avant la logique de gestion des événements spécifique avant l’appel à cette méthode de classe de base. Ajoutez la logique à appliquer après la logique de gestion des événements spécifique après l’appel à cette méthode de classe de base.

Les activités d’événements communiquent des informations de programmation d’un client ou un canal à un bot. La signification d’une activité d’événement est définie par la propriété nom de l’activité d’événement, qui est significative dans l’étendue d’un canal.

Remplacez cette valeur dans une classe dérivée pour fournir une logique spécifique aux activités ActivityTypes.InstallationUpdate.

async on_installation_update(turn_context: TurnContext)

Paramètres

Retours

Remplacez cette valeur dans une classe dérivée pour fournir une logique spécifique aux activités ActivityTypes.InstallationUpdate avec « action » définie sur « add ».

async on_installation_update_add(turn_context: TurnContext)

Paramètres

Retours

Remplacez cette valeur dans une classe dérivée pour fournir une logique spécifique aux activités ActivityTypes.InstallationUpdate avec « action » défini sur « remove ».

async on_installation_update_remove(turn_context: TurnContext)

Paramètres

Retours

Inscrit un gestionnaire d’événements d’activité pour l’événement invoke , émis pour chaque activité d’événement entrante.

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

Paramètres

Retours

Remplacez cette méthode dans une classe dérivée pour fournir une logique lorsque des membres autres que le bot rejoignent la conversation. Vous pouvez ajouter la logique d’accueil de votre bot.

activité de mise à jour de conversation :type members_added: List :p aram turn_context: Objet de contexte pour ce tour :type turn_context: TurnContext

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

Paramètres

Retours

Remarques

Lorsque la on_conversation_update_activity méthode reçoit une activité de mise à jour de conversation qui indique qu’un ou plusieurs utilisateurs autres que le bot rejoignent la conversation, elle appelle cette méthode.

Remplacez cette méthode dans une classe dérivée pour fournir une logique lorsque des membres autres que le bot quittent la conversation. Vous pouvez ajouter la logique good-bye de votre bot.

activité de mise à jour de conversation :type members_added: List :p aram turn_context: Objet de contexte pour ce tour :type turn_context: TurnContext

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

Paramètres

Retours

Remarques

Lorsque la on_conversation_update_activity méthode reçoit une activité de mise à jour de conversation qui indique qu’un ou plusieurs utilisateurs autres que le bot quittent la conversation, elle appelle cette méthode.

Remplacez cette méthode dans une classe dérivée pour fournir une logique spécifique aux activités, comme la logique conversationnelle.

async on_message_activity(turn_context: TurnContext)

Paramètres

Retours

Appelé lorsqu’une activité d’événement est reçue du connecteur lorsque le comportement de base de on_turn est utilisé.

async on_message_reaction_activity(turn_context: TurnContext)

Paramètres

Retours

Remarques

Les réactions de message correspondent à l’ajout d’un « j’aime » ou d’un « triste », etc. (souvent un emoji) à une activité précédemment envoyée.

Les réactions de message ne sont prises en charge que par quelques canaux. L’activité à laquelle correspond la réaction du message est indiquée dans la propriété de réponse à Id. La valeur de cette propriété est l’ID d’activité d’une activité précédemment envoyée remise au bot en tant que réponse d’un appel d’envoi. Lorsque la on_turn méthode reçoit une activité de réaction de message, elle appelle cette méthode.

• Si la réaction du message indique que des réactions ont été ajoutées à un message, elle appelle

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

• Si la réaction de message indique que des réactions ont été supprimées d’un message, elle appelle <xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_removed>.

Dans une classe dérivée, remplacez cette méthode pour ajouter une logique qui s’applique à toutes les activités de réaction de message. Ajoutez la logique à appliquer avant l’ajout ou la suppression de la logique avant l’appel à la méthode de cette classe de base. Ajoutez la logique à appliquer après que les réactions ont ajouté ou supprimé la logique après l’appel à la méthode de cette classe de base.

Remplacez cette méthode dans une classe dérivée pour fournir une logique quand des réactions à une activité précédente sont ajoutées à la conversation.

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

Paramètres

Retours

Remarques

Les réactions de message correspondent à l’ajout d’un « j’aime » ou d’un « triste », etc. (souvent un emoji) à un message précédemment envoyé dans la conversation. Les réactions de message ne sont prises en charge que par quelques canaux. L’activité à laquelle le message est en réaction est identifiée par la réponse de l’activité à la propriété ID. La valeur de cette propriété est l’ID d’activité d’une activité précédemment envoyée. Lorsque le bot envoie une activité, le canal lui attribue un ID, qui est disponible dans l’ID de réponse de ressource du résultat.

Remplacez cette méthode dans une classe dérivée pour fournir une logique quand les réactions à une activité précédente sont supprimées de la conversation.

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

Paramètres

Retours

Remarques

Les réactions de message correspondent à l’ajout d’un « j’aime » ou d’un « triste », etc. (souvent un emoji) à un message précédemment envoyé dans la conversation. Les réactions de message ne sont prises en charge que par quelques canaux. L’activité à laquelle le message est en réaction est identifiée par la réponse de l’activité à la propriété Id. La valeur de cette propriété est l’ID d’activité d’une activité précédemment envoyée. Lorsque le bot envoie une activité, le canal lui attribue un ID, qui est disponible dans l’ID de réponse de ressource du résultat.

Appelé lorsqu’un événement signin/verifyState ou signin/tokenExchange est reçu lorsque le comportement de base de on_invoke_activity(TurnContext{InvokeActivity}) est utilisé. Si vous utilisez un OAuthPrompt, remplacez cette méthode pour transférer cette activité vers la boîte de dialogue active. Par défaut, cette méthode ne fait rien.

async on_sign_in_invoke(turn_context: TurnContext)

Paramètres

Retours

Appelé lorsqu’un événement jetons/réponse est reçu lorsque le comportement de base de on_event_activity est utilisé. Si vous utilisez un oauth_prompt, remplacez cette méthode pour transférer cette activité vers la boîte de dialogue active.

async on_token_response_event(turn_context: TurnContext)

Paramètres

Retours

Remarques

Quand la on_event méthode reçoit un événement avec un nom d’activité de jetons/réponse, elle appelle cette méthode. Si votre bot utilise une oauth_prompt, transférez l’activité entrante au dialogue actuel.

Appelé par l’adaptateur (par exemple, <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) au moment de l’exécution afin de traiter un entrant Activity.

async on_turn(turn_context: TurnContext)

Paramètres

Retours

Remarques

Il appelle d’autres méthodes de cette classe en fonction du type de l’activité à traiter, ce qui permet à une classe dérivée de fournir une logique spécifique au type de manière contrôlée. Dans une classe dérivée, remplacez cette méthode pour ajouter une logique qui s’applique à tous les types d’activité. Également

• Ajoutez la logique à appliquer avant la logique spécifique au type et avant d’appeler on_turn.
• Ajoutez la logique à appliquer après la logique spécifique au type après l’appel on_turnde .

Remplacez cela dans une classe dérivée pour fournir une logique spécifique aux activités ActivityTypes.typing, telles que la logique conversationnelle.

async on_typing_activity(turn_context: TurnContext)

Paramètres

Retours

Appelé lorsqu’une activité autre qu’un message, une mise à jour de conversation ou un événement est reçue lorsque le comportement de base de on_turn est utilisé. Si elle est remplacée, cette méthode peut potentiellement répondre à l’un des autres types d’activité.

async on_unrecognized_activity_type(turn_context: TurnContext)

Paramètres

Retours

Remarques

Quand la on_turn méthode reçoit une activité qui n’est pas un message, une mise à jour de conversation, une réaction de message ou une activité événementielle, elle appelle cette méthode.