ActivityHandler Classe

Référence

Définition

Espace de noms:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Paquet:: Microsoft.Bot.Builder v4.22.7

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Implémentation de l’interface IBot, destinée à une sous-classe supplémentaire.

public class ActivityHandler : Microsoft.Bot.Builder.IBot

type ActivityHandler = class
    interface IBot

Public Class ActivityHandler
Implements IBot

Héritage: Object
ActivityHandler

Dérivé: Microsoft.Bot.Builder.SharePoint.SharePointActivityHandler

Microsoft.Bot.Builder.Teams.TeamsActivityHandler

Implémente: IBot

Remarques

Dérivez de cette classe pour brancher du code pour gérer des types d’activité particuliers. Vous pouvez ajouter des objets de prétraitement et de post-traitement de Activity en appelant l’implémentation de classe de base à partir de la classe dérivée.

Constructeurs

ActivityHandler()

Implémentation de l’interface IBot, destinée à une sous-classe supplémentaire.

Méthodes

CreateInvokeResponse(Object)	Une fabrique InvokeResponse qui initialise le corps au paramètre passé et l’état est égal à OK.
OnAdaptiveCardInvokeAsync(ITurnContext<IInvokeActivity>, AdaptiveCardInvokeValue, CancellationToken)	Appelé lorsque le bot reçoit une action de carte adaptative s’exécute.
OnCommandActivityAsync(ITurnContext<ICommandActivity>, CancellationToken)	Appelé lorsqu’une activité de commande est reçue lorsque le comportement de base de OnTurnAsync(ITurnContext, CancellationToken) 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.
OnCommandResultActivityAsync(ITurnContext<ICommandResultActivity>, CancellationToken)	Appelé lorsqu’une activité CommandResult est reçue lorsque le comportement de base de OnTurnAsync(ITurnContext, CancellationToken) est utilisé. Les activités CommandResult peuvent être utilisées pour communiquer le résultat d’une exécution de commande.
OnConversationUpdateActivityAsync(ITurnContext<IConversationUpdateActivity>, CancellationToken)	Appelé lorsqu’une activité de mise à jour de conversation est reçue du canal lorsque le comportement de base de OnTurnAsync(ITurnContext, CancellationToken) 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 OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) si des utilisateurs ont été ajoutés ou OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) 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.
OnEndOfConversationActivityAsync(ITurnContext<IEndOfConversationActivity>, CancellationToken)	Remplacez cela dans une classe dérivée pour fournir une logique spécifique à EndOfConversation activités, telles que la logique conversationnelle.
OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken)	Appelé lorsqu’une activité d’événement est reçue du connecteur lorsque le comportement de base de OnTurnAsync(ITurnContext, CancellationToken) 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 OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken) si le nom de l’activité est `tokens/response` ou OnEventAsync(ITurnContext<IEventActivity>, CancellationToken) sinon. Un événement `tokens/response` peut être déclenché par un OAuthCard.
OnEventAsync(ITurnContext<IEventActivity>, CancellationToken)	Appelé lorsqu’un événement autre que `tokens/response` est reçu lorsque le comportement de base de OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken) 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.
OnInstallationUpdateActivityAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)	Remplacez-le dans une classe dérivée pour fournir une logique spécifique aux activités InstallationUpdate.
OnInstallationUpdateAddAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)	Remplacez cela dans une classe dérivée pour fournir une logique spécifique à InstallationUpdate activités avec « action » définie sur « add ».
OnInstallationUpdateRemoveAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)	Remplacez cela dans une classe dérivée pour fournir une logique spécifique à InstallationUpdate activités avec « action » définie sur « remove ».
OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken)	Appelé lorsqu’une activité d’appel est reçue du connecteur lorsque le comportement de base de OnTurnAsync(ITurnContext, CancellationToken) 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(ITurnContext<IInvokeActivity>, CancellationToken) si le nom de l’activité est `signin/verifyState` ou `signin/tokenExchange`. Un appel `signin/verifyState` ou `signin/tokenExchange` peut être déclenché par un OAuthCard.
OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken)	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.
OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken)	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.
OnMessageActivityAsync(ITurnContext<IMessageActivity>, CancellationToken)	Remplacez cela dans une classe dérivée pour fournir une logique spécifique à Message activités, telles que la logique conversationnelle.
OnMessageDeleteActivityAsync(ITurnContext<IMessageDeleteActivity>, CancellationToken)	Remplacez cela dans une classe dérivée pour fournir une logique spécifique à MessageDelete activités, telles que la logique conversationnelle.
OnMessageReactionActivityAsync(ITurnContext<IMessageReactionActivity>, CancellationToken)	Appelé lorsqu’une activité d’événement est reçue du connecteur lorsque le comportement de base de OnTurnAsync(ITurnContext, CancellationToken) 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.
OnMessageUpdateActivityAsync(ITurnContext<IMessageUpdateActivity>, CancellationToken)	Remplacez cela dans une classe dérivée pour fournir une logique spécifique à MessageUpdate activités, telles que la logique conversationnelle.
OnReactionsAddedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken)	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.
OnReactionsRemovedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken)	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.
OnSearchInvokeAsync(ITurnContext<IInvokeActivity>, SearchInvokeValue, CancellationToken)	Appelé lorsque le bot est envoyé à une activité « invoke » portant le nom « application/search ».
OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken)	Appelé lorsqu’un événement `signin/verifyState` ou `signin/tokenExchange` est reçu lorsque le comportement de base de OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken) est utilisé. Si vous utilisez un `OAuthPrompt`, remplacez cette méthode pour transférer cette Activity à la boîte de dialogue active. Par défaut, cette méthode ne fait rien.
OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken)	Appelé lorsqu’un événement `tokens/response` est reçu lorsque le comportement de base de OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken) est utilisé. Si vous utilisez un `OAuthPrompt`, remplacez cette méthode pour transférer cette Activity à la boîte de dialogue active. Par défaut, cette méthode ne fait rien.
OnTurnAsync(ITurnContext, CancellationToken)	Appelé par l’adaptateur (par exemple, un BotFrameworkAdapter) lors de l’exécution pour traiter un Activityentrant.
OnTypingActivityAsync(ITurnContext<ITypingActivity>, CancellationToken)	Remplacez cela dans une classe dérivée pour fournir une logique spécifique à Typing activités, telles que la logique conversationnelle.
OnUnrecognizedActivityTypeAsync(ITurnContext, CancellationToken)	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 OnTurnAsync(ITurnContext, CancellationToken) est utilisé. En cas de substitution, cela peut potentiellement répondre à l’un des autres types d’activités tels que ContactRelationUpdate ou EndOfConversation. Par défaut, cette méthode ne fait rien.

S’applique à

Partager via