ActivityHandler Classe

public ActivityHandler()

protected InvokeResponse createInvokeResponse(Object body)

Crée un invokeResponse de réussite avec le corps spécifié.

Paramètres:

Retours:

protected CompletableFuture onAdaptiveCardInvoke(TurnContext turnContext, AdaptiveCardInvokeValue invokeValue)

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

Paramètres:

Retours:

protected CompletableFuture onCommandActivity(TurnContext turnContext)

Appelé lorsqu’une activité de commande est reçue lorsque le comportement de base de onTurn(TurnContext turnContext) est utilisé. Les commandes sont des demandes d’exécution d’une action et de récepteurs qui répondent généralement avec une ou plusieurs activités commandResult. Les récepteurs sont également censés rejeter explicitement les activités de commande non prises en charge.

Paramètres:

Retours:

protected CompletableFuture onCommandResultActivity(TurnContext turnContext)

Appelé lorsqu’une activité CommandResult est reçue lorsque le comportement de base de onTurn(TurnContext turnContext) est utilisé. Les activités CommandResult peuvent être utilisées pour communiquer le résultat d’une exécution de commande.

Paramètres:

Retours:

protected CompletableFuture onConversationUpdateActivity(TurnContext turnContext)

Appelé lorsqu’une activité de mise à jour de conversation est reçue du canal lorsque le comportement de base de onTurn(TurnContext turnContext) est utilisé.

Les activités de mise à jour de conversation sont utiles lorsqu’il s’agit de répondre aux utilisateurs ajoutés ou supprimés de la conversation.

Par exemple, un bot peut répondre à un utilisateur ajouté en saluant l’utilisateur. Par défaut, cette méthode appelle onMembersAdded(List<ChannelAccount> membersAdded, TurnContext turnContext) si des utilisateurs ont été ajoutés ou onMembersRemoved(List<ChannelAccount> membersRemoved, TurnContext turnContext) si des utilisateurs ont été supprimés. La méthode vérifie l’ID de membre afin qu’il réponde uniquement aux mises à jour concernant les membres autres que le bot lui-même.

Paramètres:

Retours:

protected CompletableFuture onEndOfConversationActivity(TurnContext turnContext)

Remplacez cela dans une classe dérivée pour fournir une logique spécifique aux activités ActivityTypes.END_OF_CONVERSATION.

Paramètres:

Retours:

protected CompletableFuture onEvent(TurnContext turnContext)

Appelé lorsqu’un événement autre que les jetons/réponses est reçu lorsque le comportement de base de onEventActivity(TurnContext turnContext) est utilisé.

Cette méthode peut éventuellement être remplacée si le bot est destiné à gérer divers événements.

Par défaut, cette méthode ne fait rien.

Lorsque la méthode onEventActivity(TurnContext turnContext) reçoit un événement avec une Activity#getName() autre que « jetons/réponse », elle appelle cette méthode.

Paramètres:

Retours:

protected CompletableFuture onEventActivity(TurnContext turnContext)

Appelé lorsqu’une activité d’événement est reçue du connecteur lorsque le comportement de base de onTurn(TurnContext turnContext) est utilisé.

Les activités d’événement peuvent être utilisées pour communiquer de nombreuses choses différentes.

Par défaut, cette méthode appelle onTokenResponseEvent(TurnContext turnContext) si le nom de l’activité est « jetons/réponse » ou onEvent(TurnContext turnContext) sinon. L’événement « tokens/response » peut être déclenché par un com.microsoft.bot.schema.OAuthCard.

Lorsque la méthode onTurn(TurnContext turnContext) reçoit une activité d’événement, elle appelle cette méthode.

Si l’événement Activity#getName est « tokens/response », il appelle onTokenResponseEvent(TurnContext turnContext) sinon, il appelle onEvent(TurnContext turnContext).

Dans une classe dérivée, substituez cette méthode pour ajouter une logique qui s’applique à toutes les activités d’événement. Ajoutez une logique à appliquer avant la logique de gestion des événements spécifique avant l’appel à la 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 à la méthode de classe de base.

Les activités d’événement communiquent des informations programmatiques d’un client ou d’un canal à un bot. La signification d’une activité d’événement est définie par la propriété Activity#getName, qui est significative dans l’étendue d’un canal. Un événement « tokens/response » peut être déclenché par un com.microsoft.bot.schema.OAuthCard ou une invite OAuth.

Paramètres:

Retours:

protected CompletableFuture onInstallationUpdate(TurnContext turnContext)

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

Paramètres:

Retours:

protected CompletableFuture onInstallationUpdateAdd(TurnContext turnContext)

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

Paramètres:

Retours:

protected CompletableFuture onInstallationUpdateRemove(TurnContext turnContext)

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

Paramètres:

Retours:

protected CompletableFuture onInvokeActivity(TurnContext turnContext)

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

Les activités d’appel peuvent être utilisées pour communiquer de nombreuses choses différentes. Par défaut, cette méthode appelle onSignInInVokeAsync si le nom de l’activité est « signin/verifyState » ou « signin/tokenExchange ».

Un appel « signin/verifyState » ou « signin/tokenExchange » peut être déclenché par une carte OAuthCard.

Paramètres:

Retours:

protected CompletableFuture onMembersAdded(List membersAdded, TurnContext turnContext)

Remplacez cela dans une classe dérivée pour fournir une logique pour quand des membres autres que le bot rejoignent la conversation, comme la logique d’accueil de votre bot.

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

Paramètres:

Retours:

protected CompletableFuture onMembersRemoved(List membersRemoved, TurnContext turnContext)

Remplacez cela dans une classe dérivée pour fournir une logique lorsque les membres autres que le bot quittent la conversation, comme la logique de bon octet de votre bot.

Lorsque la méthode onConversationUpdateActivity(TurnContext turnContext) 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.

Paramètres:

Retours:

protected CompletableFuture onMessageActivity(TurnContext turnContext)

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

Lorsque la méthode onTurn(TurnContext turnContext) reçoit une activité de message, elle appelle cette méthode.

Paramètres:

Retours:

protected CompletableFuture onMessageReactionActivity(TurnContext turnContext)

Appelé lorsqu’une activité d’événement est reçue du connecteur lorsque le comportement de base de onTurn(TurnContext turnContext) est utilisé.

Les réactions de message correspondent à l’utilisateur en ajoutant un « like » ou « sad », etc. (souvent un emoji) à une activité précédemment envoyée. Les réactions aux messages 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é replyToId. 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 méthode onTurn(TurnContext turnContext) reçoit une activité de réaction de message, elle appelle cette méthode. Si la réaction du message indique que les réactions ont été ajoutées à un message, elle appelle onReactionsAdded(List<MessageReaction> messageReactions, TurnContext turnContext). Si la réaction du message indique que les réactions ont été supprimées d’un message, elle appelle onReactionsRemoved(List<MessageReaction> messageReactions, TurnContext turnContext).

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

Paramètres:

Retours:

protected CompletableFuture onReactionsAdded(List messageReactions, TurnContext turnContext)

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

Les réactions aux messages correspondent à l’utilisateur en ajoutant un message « like » ou « sad », etc. (souvent un emoji) à un message précédemment envoyé sur la conversation. Les réactions aux messages ne sont prises en charge que par quelques canaux. L’activité à laquelle le message est en réaction est identifiée par la propriété Activity#getReplyToId() de l’activité. 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 le com.microsoft.bot.schema.ResourceResponse#getId du résultat.

Paramètres:

Retours:

protected CompletableFuture onReactionsRemoved(List messageReactions, TurnContext turnContext)

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

Les réactions aux messages correspondent à l’utilisateur en ajoutant un message « like » ou « sad », etc. (souvent un emoji) à un message précédemment envoyé sur la conversation. Les réactions aux messages ne sont prises en charge que par quelques canaux. L’activité à laquelle le message est en réaction est identifiée par la propriété Activity#getReplyToId() de l’activité. 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 le com.microsoft.bot.schema.ResourceResponse#getId du résultat.

Paramètres:

Retours:

protected CompletableFuture onSignInInvoke(TurnContext turnContext)

Appelé lorsqu’un événement « signin/verifyState » ou « signin/tokenExchange » est reçu lorsque le comportement de base d’onInvokeActivity est utilisé.

Si vous utilisez un OAuthPrompt, remplacez cette méthode pour transférer cette activité à la boîte de dialogue active. Par défaut, cette méthode ne fait rien.

Lorsque la méthode onInvokeActivity reçoit un Invoke avec le nom « tokens/response », elle appelle cette méthode.

Si votre bot utilise OAuthPrompt, transférez l’activité entrante à la boîte de dialogue actuelle.

Paramètres:

Retours:

protected CompletableFuture onTokenResponseEvent(TurnContext turnContext)

Appelé lorsqu’un événement « tokens/response » est reçu lorsque le comportement de base de onEventActivity(TurnContext turnContext) est utilisé.

Si vous utilisez un OAuthPrompt, remplacez cette méthode pour transférer cette Activity à la boîte de dialogue actuelle.

Par défaut, cette méthode ne fait rien.

Lorsque la méthode onEventActivity(TurnContext turnContext) reçoit un événement avec un Activity#getName() de « jetons/réponse », elle appelle cette méthode.

Paramètres:

Retours:

public CompletableFuture onTurn(TurnContext turnContext)

Appelé par l’adaptateur (par exemple, un BotFrameworkAdapter) lors de l’exécution pour traiter un Activityentrant.

Cette méthode 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é. Ajoutez une logique à appliquer avant la logique spécifique au type avant l’appel à la classe de base onTurn(TurnContext turnContext) méthode. Ajoutez une logique à appliquer après la logique spécifique au type après l’appel à la classe de base onTurn(TurnContext turnContext) méthode.

Paramètres:

Retours:

protected CompletableFuture onTypingActivity(TurnContext turnContext)

Remplacez ce paramètre dans une classe dérivée pour fournir une logique spécifique aux activités ActivityTypes.Typing.

Paramètres:

Retours:

protected CompletableFuture onUnrecognizedActivityType(TurnContext turnContext)

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 onTurn(TurnContext turnContext) est utilisé.

En cas de substitution, cela peut potentiellement répondre à l’un des autres types d’activités tels que com.microsoft.bot.schema.ActivityTypes#CONTACT_RELATION_UPDATE ou com.microsoft.bot.schema.ActivityTypes#END_OF_CONVERSATION.

Par défaut, cette méthode ne fait rien.

Lorsque la méthode onTurn(TurnContext turnContext) 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.

Paramètres:

Retours: