TeamsActivityHandler class

Inscrit un gestionnaire pour les événements TeamsChannelCreated, par exemple lorsqu’un canal est créé.

function onTeamsChannelCreatedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour les événements TeamsChannelDeleted, par exemple lorsqu’un canal est supprimé.

function onTeamsChannelDeletedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour les événements TeamsChannelRenamed, par exemple lorsqu’un canal est renommé.

function onTeamsChannelRenamedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour les événements TeamsChannelRestored, par exemple lorsqu’un canal est restauré.

function onTeamsChannelRestoredEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour la fin d’une réunion Teams.

function onTeamsMeetingEndEvent(handler: (meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour le démarrage d’une réunion Teams.

function onTeamsMeetingStartEvent(handler: (meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour les événements TeamsMembersAdded, par exemple lorsque les membres autres que le bot rejoignent le canal, comme la logique d’accueil de votre bot.

function onTeamsMembersAddedEvent(handler: (membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour les événements TeamsMembersRemoved, par exemple lorsque les membres autres que le bot quittent le canal, comme la logique d’octet de votre bot.

function onTeamsMembersRemovedEvent(handler: (membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour lequel un reçu de lecture est envoyé.

function onTeamsReadReceiptEvent(handler: (receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour les événements TeamsTeamArchived, par exemple lorsqu’une équipe est archivée.

function onTeamsTeamArchivedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour les événements TeamsTeamDeleted, par exemple lorsqu’une équipe est supprimée.

function onTeamsTeamDeletedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour les événements TeamsTeamHardDeleted, par exemple lorsqu’une équipe est supprimée en dur.

function onTeamsTeamHardDeletedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour les événements TeamsTeamRenamed, par exemple lorsqu’une équipe est renommée.

function onTeamsTeamRenamedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour les événements TeamsTeamRestored, par exemple lorsqu’une équipe est restaurée.

function onTeamsTeamRestoredEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

Inscrit un gestionnaire pour les événements TeamsTeamUnarchived, par exemple lorsqu’une équipe n’est pasarchivée.

function onTeamsTeamUnarchivedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Paramètres

Retours

Promesse qui représente le travail mis en file d’attente.

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

function onCommand(handler: BotHandler): this

Paramètres

Retours

Référence à l’objet ActivityHandler .

Remarques

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

héritée de ActivityHandler.onCommand

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

function onCommandResult(handler: BotHandler): this

Paramètres

Retours

Référence à l’objet ActivityHandler .

Remarques

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

héritée de ActivityHandler.onCommandResult

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

Retours

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 le moment où les membres sont ajoutés ou supprimés de la conversation, utilisez les gestionnaires d’événements de sous-type onMembersAdded et onMembersRemoved.

héritée de ActivityHandler.onConversationUpdate

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

function onDialog(handler: BotHandler): this

Paramètres

Retours

Référence à l’objet ActivityHandler .

héritée de ActivityHandler.onDialog

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

function onEndOfConversation(handler: BotHandler): this

Paramètres

Retours

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 gestionnaire d’événements spécifique au type.

héritée de ActivityHandler.onEndOfConversation

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

function onEvent(handler: BotHandler): this

Paramètres

Retours

Référence à l’objet ActivityHandler .

Remarques

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 le nom de l’activité propriété, qui est significative dans l’étendue d’un canal. Les activités d’événement sont conçues pour contenir des informations interactives (telles que des clics de bouton) et des informations non interactives (telles qu’une notification d’un client mettant automatiquement à jour un modèle speech incorporé).

Pour gérer un événement d’événement , utilisez le gestionnaire d’événements onTokenResponseEvent. Pour gérer d’autres événements nommés, ajoutez une logique à ce gestionnaire.

héritée de ActivityHandler.onEvent

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

function onInstallationUpdate(handler: BotHandler): this

Paramètres

Retours

Référence à l’objet ActivityHandler .

Remarques

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

héritée de ActivityHandler.onInstallationUpdate

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

function onInstallationUpdateAdd(handler: BotHandler): this

Paramètres

Retours

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

héritée de ActivityHandler.onInstallationUpdateAdd

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

function onInstallationUpdateRemove(handler: BotHandler): this

Paramètres

Retours

Référence à l’objet ActivityHandler .

Remarques

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

héritée de ActivityHandler.onInstallationUpdateRemove

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

function onMembersAdded(handler: BotHandler): this

Paramètres

Retours

Référence à l’objet ActivityHandler .

Remarques

La propriété membresAdded 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 onConversationUpdate de type.

héritée de ActivityHandler.onMembersAdded

Inscrit un gestionnaire d’événements d’activité pour les membres supprimés événement, é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

Retours

Référence à l’objet ActivityHandler .

Remarques

La propriété membres de l’activitéRemoved 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 onConversationUpdate de type.

héritée de ActivityHandler.onMembersRemoved

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

function onMessage(handler: BotHandler): this

Paramètres

Retours

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é texte de l’activité peut être null ou undefined.

héritée de ActivityHandler.onMessage

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

function onMessageReaction(handler: BotHandler): this

Paramètres

Retours

Référence à l’objet ActivityHandler .

Remarques

Les activités de réaction aux messages représentent une interaction sociale sur une activité de message existante au sein d’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 de propriété représente la source de la réaction, telle que l’utilisateur qui a réagi au message.

Pour gérer le moment où des réactions sont ajoutées ou supprimées des messages dans la conversation, utilisez les gestionnaires d’événements onReactionsAdded et onReactionsRemoved sous-types d’événements.

héritée de ActivityHandler.onMessageReaction

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

function onReactionsAdded(handler: BotHandler): this

Paramètres

Retours

Référence à l’objet ActivityHandler .

Remarques

La propriété réaction de l’activitéAdded comprend une ou plusieurs réactions qui ont été ajoutées.

Pour gérer les événements de réaction aux messages en général, utilisez le gestionnaire d’événements onMessageReaction de type.

héritée de ActivityHandler.onReactionsAdded

Inscrit un gestionnaire d’événements d’activité pour les réactions supprimées événement, é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

Retours

Référence à l’objet ActivityHandler .

Remarques

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

Pour gérer les événements de réaction aux messages en général, utilisez le gestionnaire d’événements onMessageReaction de type.

héritée de ActivityHandler.onReactionsRemoved

Inscrit un gestionnaire d’événements d’activité pour l’événement tokens-response, émis pour toute activité d’événement de tokens/response entrante. Celles-ci sont générées dans le cadre du flux d’authentification OAuth.

function onTokenResponseEvent(handler: BotHandler): this

Paramètres

Retours

Référence à l’objet ActivityHandler .

Remarques

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

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

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

héritée de ActivityHandler.onTokenResponseEvent

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

function onTurn(handler: BotHandler): this

Paramètres

Retours

Référence à l’objet ActivityHandler .

héritée de ActivityHandler.onTurn

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

function onTyping(handler: BotHandler): this

Paramètres

Retours

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.

héritée de ActivityHandler.onTyping

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

function onUnrecognizedActivityType(handler: BotHandler): this

Paramètres

Retours

Référence à l’objet ActivityHandler .

Remarques

Le ActivityHandler ne définit pas d’événements 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 avec des types qui ne se trouvent 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.

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

héritée de ActivityHandler.onUnrecognizedActivityType

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

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

Paramètres

Retours

Remarques

En règle générale, vous fournissez cette méthode en tant que gestionnaire de fonctions 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 routé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 également

• BotFrameworkAdapter.processActivity

héritée de ActivityHandler.run