ActivityHandler Classe

Gère les activités et doit être sous-classé.

Héritage

Bot

ActivityHandler

Constructeur

ActivityHandler()

Remarques

Dérivez de cette classe pour gérer des types d’activité particuliers. Yon peut ajouter le pré et le post-traitement des activités en appelant la classe de base dans la classe dérivée.

Méthodes

on_adaptive_card_invoke	Appelé lorsque le bot reçoit une action d’exécution de carte adaptative. Lorsque la méthode on_invoke_activity reçoit un invoke avec une Activity.name d’adaptiveCard/action, elle appelle cette méthode.
on_conversation_update_activity	Appelé lorsqu’une activité de mise à jour de conversation est reçue du canal lorsque le comportement de base de on_turn est utilisé.
on_end_of_conversation_activity	Appelé lorsqu’une activité de fin de conversation est reçue du canal.
on_event	Appelé lorsqu’un événement autre que les jetons/réponse est reçu lorsque le comportement de base de on_event_activity est utilisé.
on_event_activity	Appelé lorsqu’une activité d’événement est reçue du connecteur lorsque le comportement de base de on_turn est utilisé.
on_installation_update	Remplacez cette valeur dans une classe dérivée pour fournir une logique spécifique aux activités ActivityTypes.InstallationUpdate.
on_installation_update_add	Remplacez cela dans une classe dérivée pour fournir une logique spécifique aux activités ActivityTypes.InstallationUpdate avec « action » défini sur « add ».
on_installation_update_remove	Remplacez cela dans une classe dérivée pour fournir une logique spécifique aux activités ActivityTypes.InstallationUpdate avec « action » défini sur « remove ».
on_invoke_activity	Inscrit un gestionnaire d’événements d’activité pour l’événement invoke , émis pour chaque activité d’événement entrante.
on_members_added_activity	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 de ce tour :type turn_context : TurnContext
on_members_removed_activity	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 d’au-bout de votre bot. activité de mise à jour de conversation :type members_added : List :p aram turn_context : objet de contexte de ce tour :type turn_context : TurnContext
on_message_activity	Remplacez cette méthode dans une classe dérivée pour fournir une logique spécifique aux activités, telles que la logique conversationnelle.
on_message_reaction_activity	Appelé lorsqu’une activité d’événement est reçue du connecteur lorsque le comportement de base de on_turn est utilisé.
on_reactions_added	Remplacez cette méthode dans une classe dérivée pour fournir une logique pour quand des réactions à une activité précédente sont ajoutées à la conversation.
on_reactions_removed	Remplacez cette méthode dans une classe dérivée pour fournir une logique pour quand les réactions à une activité précédente sont supprimées de la conversation.
on_sign_in_invoke	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.
on_token_response_event	Appelé lorsqu’un événement de jetons/réponse est reçu lorsque le comportement de base de on_event_activity est utilisé. Si vous utilisez une oauth_prompt, remplacez cette méthode pour transférer cette activité au dialogue actuel.
on_turn	Appelé par l’adaptateur (par exemple, BotFrameworkAdapter) au moment de l’exécution afin de traiter un entrant Activity.
on_typing_activity	Remplacez cette valeur dans une classe dérivée pour fournir une logique spécifique aux activités ActivityTypes.typing, telles que la logique conversationnelle.
on_unrecognized_activity_type	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é. En cas de substitution, cette méthode peut potentiellement répondre à l’un des autres types d’activité.

on_adaptive_card_invoke

Appelé lorsque le bot reçoit une action d’exécution de carte adaptative.

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

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

Paramètres

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour.
invoke_value Obligatoire	<xref:botframework.schema.models.AdaptiveCardInvokeValue> Objet de type chaîne à partir de la valeur de l’activité entrante.

Retours

Type	Description
	Objet HealthCheckResponse

on_conversation_update_activity

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

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

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 ajoute ou supprime la logique avant l’appel à cette méthode de classe de base.

on_end_of_conversation_activity

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

async on_end_of_conversation_activity(turn_context: TurnContext)

Paramètres

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

on_event

Appelé lorsqu’un événement autre que les 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

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

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.

on_event_activity

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

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

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 une 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.

on_installation_update

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

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

on_installation_update_add

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

async on_installation_update_add(turn_context: TurnContext)

Paramètres

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

on_installation_update_remove

Remplacez cela 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

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

on_invoke_activity

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

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

on_members_added_activity

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 de ce tour :type turn_context : TurnContext

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

Paramètres

Nom	Description
members_added Obligatoire
turn_context Obligatoire

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

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.

on_members_removed_activity

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 d’au-bout de votre bot.

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

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

Paramètres

Nom	Description
members_removed Obligatoire
turn_context Obligatoire

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

Remarques

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

on_message_activity

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

async on_message_activity(turn_context: TurnContext)

Paramètres

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

on_message_reaction_activity

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

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

Remarques

Les réactions de message correspondent à l’ajout d’un « like » 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é répondre à id. La valeur de cette propriété est l’ID d’activité d’une activité précédemment envoyée 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.ActivityHandler.on_reaction_added>.

• Si la réaction du message indique que des réactions ont été supprimées d’un message, elle appelle <xref:botbuilder.core.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 les réactions ajoutées ou supprimées avant l’appel à la méthode de cette classe de base. Ajoutez la logique à appliquer après les réactions ajoutées ou supprimées après l’appel à la méthode de cette classe de base.

on_reactions_added

Remplacez cette méthode dans une classe dérivée pour fournir une logique pour 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

Nom	Description
message_reactions Obligatoire	List Liste des réactions ajoutées
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

Remarques

Les réactions de message correspondent à l’ajout d’un message « j’aime » ou « triste », etc. (souvent un emoji) à un message précédemment envoyé sur 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 affecte un ID, qui est disponible dans l’ID de réponse de ressource du résultat.

on_reactions_removed

Remplacez cette méthode dans une classe dérivée pour fournir une logique pour 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

Nom	Description
message_reactions Obligatoire	List Liste des réactions supprimées
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

Remarques

Les réactions de message correspondent à l’ajout d’un message « j’aime » ou « triste », etc. (souvent un emoji) à un message précédemment envoyé sur 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 affecte un ID, qui est disponible dans l’ID de réponse de ressource du résultat.

on_sign_in_invoke

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

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

on_token_response_event

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

async on_token_response_event(turn_context: TurnContext)

Paramètres

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente pour l’exécution

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 vers la boîte de dialogue actuelle.

on_turn

Appelé par l’adaptateur (par exemple, BotFrameworkAdapter) au moment de l’exécution afin de traiter un entrant Activity.

async on_turn(turn_context: TurnContext)

Paramètres

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente à exécuter

Remarques

Elle 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 .

on_typing_activity

Remplacez cette valeur 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

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente à exécuter

on_unrecognized_activity_type

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é. En cas de substitution, cette méthode peut potentiellement répondre à l’un des autres types d’activité.

async on_unrecognized_activity_type(turn_context: TurnContext)

Paramètres

Nom	Description
turn_context Obligatoire	TurnContext Objet de contexte pour ce tour

Retours

Type	Description
	Tâche qui représente le travail mis en file d’attente à exécuter

Remarques

Lorsque 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é d’événement, elle appelle cette méthode.