ActivityHandler class

Paquet:

botbuilder-core

Gestionnaire d’activités émettrices d’événements pour les bots. Étend ActivityHandlerBase.

Extends

ActivityHandlerBase

Remarques

Cela fournit une classe extensible pour gérer les activités entrantes de manière pilotée par les événements. Vous pouvez inscrire un ensemble arbitraire de gestionnaires pour chaque type d’événement.

Pour inscrire un gestionnaire pour un événement, utilisez la méthode d’événement on correspondante. Si plusieurs gestionnaires sont inscrits pour un événement, ils sont exécutés dans l’ordre dans lequel ils ont été inscrits.

Cet objet émet une série d’événements pendant qu’il traite une activité entrante. Un gestionnaire peut arrêter la propagation de l’événement en n’appelant pas la fonction continuation.

Type d'événement	Description
Tourner	Émis en premier pour chaque activité.
Spécifique au type	Émis pour le type d’activité spécifique, avant d’émettre un événement pour n’importe quel sous-type.
Sous-type	Émis pour certains événements spécialisés, en fonction du contenu de l’activité.
Boîte de dialogue	Émis en tant qu’événement de traitement de l’activité finale.

Par exemple :

const bot = new ActivityHandler();

server.post('/api/messages', (req, res) => {
    adapter.processActivity(req, res, async (context) => {
        // Route to bot's activity logic.
        await bot.run(context);
    });
});

bot.onTurn(async (context, next) => {
        // Handle a "turn" event.
        await context.sendActivity(`${ context.activity.type } activity received.`);
        // Continue with further processing.
        await next();
    })
    .onMessage(async (context, next) => {
        // Handle a message activity.
        await context.sendActivity(`Echo: ${ context.activity.text }`);
        // Continue with further processing.
        await next();
    });

Voir aussi

• Schéma d’activité de Bot Framework

Méthodes

onCommand(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’activité de commande .
onCommandResult(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’activité CommandResult .
onConversationUpdate(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’événement de mise à jour de conversation , émis pour chaque activité de mise à jour de conversation entrante.
onDialog(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’événement de dialogue , émis comme dernier événement pour une activité entrante.
onEndOfConversation(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’activité de fin de conversation .
onEvent(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’événement d’événement , émis pour chaque activité d’événement entrante.
onInstallationUpdate(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’activité installationupdate .
onInstallationUpdateAdd(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’activité d’ajout installationupdate .
onInstallationUpdateRemove(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’activité de suppression installationupdate .
onMembersAdded(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’événement de membres ajoutés , émis pour toute activité de mise à jour de conversation entrante qui inclut des membres ajoutés à la conversation.
onMembersRemoved(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’événement supprimé des membres , émis pour toute activité de mise à jour de conversation entrante qui inclut les membres supprimés de la conversation.
onMessage(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’événement de message , émis pour chaque activité de message entrant.
onMessageReaction(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’événement de réaction au message , émis pour chaque activité de réaction de message entrante.
onReactionsAdded(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’événement de réactions ajouté , émis pour toute activité de réaction de message entrant qui décrit les réactions ajoutées à un message.
onReactionsRemoved(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’événement de suppression des réactions , émis pour toute activité de réaction de message entrante qui décrit les réactions supprimées d’un message.
onTokenResponseEvent(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’événement tokens-response , émis pour toute activité d’événement entrant tokens/response . Ils sont générés dans le cadre du flux d’authentification OAuth.
onTurn(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’événement turn , émis pour chaque activité entrante, quel que soit le type.
onTyping(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’activité de saisie .
onUnrecognizedActivityType(BotHandler)	Inscrit un gestionnaire d’événements d’activité pour l’événement de type d’activité non reconnu , émis pour une activité entrante avec un type pour lequel activityHandler ne fournit pas de gestionnaire d’événements.
run(TurnContext)	Appelé pour lancer le processus d’émission d’événement.

Détails de la méthode

onCommand(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’activité de commande .

function onCommand(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

Pour gérer un événement Command, utilisez le gestionnaire d’événements spécifique au type onCommand .

onCommandResult(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’activité CommandResult .

function onCommandResult(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

Pour gérer un événement CommandResult, utilisez le gestionnaire d’événements spécifique au type onCommandResult .

onConversationUpdate(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement de mise à jour de conversation , émis pour chaque activité de mise à jour de conversation entrante.

function onConversationUpdate(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

Les activités de mise à jour de conversation décrivent les modifications apportées aux métadonnées d’une conversation, telles que le titre, les participants ou d’autres informations spécifiques au canal.

Pour gérer quand des membres sont ajoutés ou supprimés de la conversation, utilisez les gestionnaires d’événements de sous-type onMembersAdded et onMembersRemoved .

onDialog(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement de dialogue , émis comme dernier événement pour une activité entrante.

function onDialog(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

onEndOfConversation(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’activité de fin de conversation .

function onEndOfConversation(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

Cette activité est généralement envoyée d’une compétence à un appelant de compétence indiquant la fin de cette conversation enfant particulière.

Pour gérer une fin de conversation, utilisez le gestionnaire d’événements onEndOfConversation spécifique au type.

onEvent(BotHandler)

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

function onEvent(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

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é name de l’activité, qui est significative dans l’étendue d’un canal. Les activités d’événements sont conçues pour transporter à la fois des informations interactives (telles que des clics de bouton) et des informations non interactives (telles qu’une notification signalant qu’un client a effectué une mise à jour automatique d’un modèle de reconnaissance vocale incorporé).

Pour gérer un événement d’événement tokens/response , utilisez le gestionnaire d’événements de sous-type onTokenResponseEvent . Pour gérer d’autres événements nommés, ajoutez une logique à ce gestionnaire.

onInstallationUpdate(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’activité installationupdate .

function onInstallationUpdate(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

Pour gérer un événement InstallationUpdate, utilisez le gestionnaire d’événements spécifique au type onInstallationUpdate .

onInstallationUpdateAdd(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’activité d’ajout installationupdate .

function onInstallationUpdateAdd(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler . Pour gérer un événement InstallationUpdateAdd, utilisez le gestionnaire d’événements spécifique au type onInstallationUpdateAdd .

onInstallationUpdateRemove(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’activité de suppression installationupdate .

function onInstallationUpdateRemove(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

Pour gérer un événement InstallationUpdateRemove, utilisez le gestionnaire d’événements spécifique au type onInstallationUpdateRemove .

onMembersAdded(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement de membres ajoutés , émis pour toute activité de mise à jour de conversation entrante qui inclut des membres ajoutés à la conversation.

function onMembersAdded(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

La propriété membersAdded de l’activité contient les membres ajoutés à la conversation, qui peuvent inclure le bot.

Pour gérer les événements de mise à jour de conversation en général, utilisez le gestionnaire d’événements spécifique au type onConversationUpdate .

onMembersRemoved(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement supprimé des membres , émis pour toute activité de mise à jour de conversation entrante qui inclut les membres supprimés de la conversation.

function onMembersRemoved(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

La propriété membersremoved de l’activité contient les membres supprimés de la conversation, qui peuvent inclure le bot.

Pour gérer les événements de mise à jour de conversation en général, utilisez le gestionnaire d’événements spécifique au type onConversationUpdate .

onMessage(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement de message , émis pour chaque activité de message entrant.

function onMessage(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

Les activités de message représentent du contenu destiné à être affiché dans une interface conversationnelle et peuvent contenir du texte, de la parole, des cartes interactives et des pièces jointes binaires ou inconnues. Toutes les activités de message ne contiennent pas de texte, la propriété de texte de l’activité peut être null ou undefined.

onMessageReaction(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement de réaction au message , émis pour chaque activité de réaction de message entrante.

function onMessageReaction(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

Les activités de réaction à un message représentent une interaction sociale sur une activité de message existante dans une conversation. L’activité d’origine est référencée par la propriété replyToId de l’activité de réaction de message. La propriété from représente la source de la réaction, par exemple l’utilisateur qui a réagi au message.

Pour gérer quand des réactions sont ajoutées ou supprimées de messages dans la conversation, utilisez les gestionnaires d’événements de sous-type onReactionsAdded et onReactionsRemoved .

onReactionsAdded(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement de réactions ajouté , émis pour toute activité de réaction de message entrant qui décrit les réactions ajoutées à un message.

function onReactionsAdded(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

La propriété reactionsAdded de l’activité inclut une ou plusieurs réactions qui ont été ajoutées.

Pour gérer les événements de réaction de message en général, utilisez le gestionnaire d’événements spécifique au type onMessageReaction .

onReactionsRemoved(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement de suppression des réactions , émis pour toute activité de réaction de message entrante qui décrit les réactions supprimées d’un message.

function onReactionsRemoved(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

La propriété réactionsRemoved de l’activité inclut une ou plusieurs réactions qui ont été supprimées.

Pour gérer les événements de réaction de message en général, utilisez le gestionnaire d’événements spécifique au type onMessageReaction .

onTokenResponseEvent(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement tokens-response , émis pour toute activité d’événement entrant tokens/response . Ils sont générés dans le cadre du flux d’authentification OAuth.

function onTokenResponseEvent(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

La propriété value de l’activité contient le jeton utilisateur.

Si votre bot gère l’authentification à l’aide d’un OAuthPrompt dans une boîte de dialogue, le dialogue doit recevoir cette activité pour terminer le flux d’authentification.

Pour gérer d’autres événements nommés et événements d’événement en général, utilisez le gestionnaire d’événements spécifique au type onEvent .

onTurn(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement turn , émis pour chaque activité entrante, quel que soit le type.

function onTurn(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

onTyping(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’activité de saisie .

function onTyping(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

Pour gérer un événement de saisie, utilisez le gestionnaire d’événements onTyping spécifique au type.

onUnrecognizedActivityType(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement de type d’activité non reconnu , émis pour une activité entrante avec un type pour lequel activityHandler ne fournit pas de gestionnaire d’événements.

function onUnrecognizedActivityType(handler: BotHandler): this

Paramètres

handler

BotHandler

Gestionnaire d'événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

ne définit pas d’événements ActivityHandler pour tous les types d’activité définis dans le schéma d’activité Bot Framework. En outre, les canaux et les adaptateurs personnalisés peuvent créer des activités dont les types ne sont pas dans le schéma. Lorsque le gestionnaire d’activités reçoit un tel événement, il émet un événement de type d’activité non reconnu.

La propriété de type de l’activité contient le type d’activité.

run(TurnContext)

Appelé pour lancer le processus d’émission d’événement.

function run(context: TurnContext): Promise<void>

Paramètres

context

TurnContext

Objet de contexte pour le tour actuel.

Retours

Promise<void>

Remarques

En règle générale, vous devez fournir cette méthode comme gestionnaire de fonction que l’adaptateur appelle pour exécuter la logique du bot après que l’activité reçue a été prétraitée par l’adaptateur et acheminée via n’importe quel intergiciel.

Par exemple :

 server.post('/api/messages', (req, res) => {
     adapter.processActivity(req, res, async (context) => {
         // Route to bot's activity logic.
         await bot.run(context);
     });
});

Voir aussi

• BotFrameworkAdapter.processActivity