TeamsActivityHandler class

Ajoute la prise en charge des événements et interactions spécifiques à Microsoft Teams.

Extends

ActivityHandler

Remarques

Les développeurs peuvent gérer les activités de mise à jour de conversation envoyées par Microsoft Teams via deux méthodes :

  1. Substitution de méthodes commençant par on.. et ne se terminant ..Event() pas par (par exemple onTeamsMembersAdded()), ou à la place
  2. Passage de rappels à des méthodes commençant par on..et se terminant ...Event() par (par exemple onTeamsMembersAddedEvent()), pour rester en ligne avec l’ancienne implémentation de {@see ActivityHandler}.

Les développeurs doivent utiliser #1 ou #2, surtout pour toutes les activités de mise à jour de conversation, et non pas #2 et #3 pour la même activité. Cela signifie que les développeurs doivent remplacer onTeamsMembersAdded() et ne pas utiliser les deux onTeamsMembersAdded() et onTeamsMembersAddedEvent().

Les développeurs qui veulent gérer les activités Invoke doivent remplacer les méthodes commençant par handle...() (par exemple handleTeamsTaskModuleFetch()).

Méthodes

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Méthodes héritées

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 boîte de dialogue , émis comme dernier événement pour une activité entrante.

onEndOfConversation(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour la fin de l’activité 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 d’installationupdate .

onMembersAdded(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement ajouté aux membres , émis pour toute activité de mise à jour de conversation entrante qui inclut les 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 entrante.

onMessageReaction(BotHandler)

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.

onReactionsAdded(BotHandler)

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

onReactionsRemoved(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement supprimé 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 entrante tokens/response . Celles-ci sont générées dans le cadre du flux d’authentification OAuth.

onTurn(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement de tour , é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 le Gestionnaire d’événements ne fournit pas de gestionnaire d’événements.

run(TurnContext)

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

Détails de la méthode

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

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

handler

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

Rappel pour gérer l’événement créé par le canal Teams.

Retours

this

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

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

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

handler

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

Rappel pour gérer l’événement supprimé du canal Teams.

Retours

this

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

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

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

handler

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

Rappel pour gérer l’événement renommé du canal Teams.

Retours

this

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

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

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

handler

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

Rappel permettant de gérer l’événement restauré par le canal Teams.

Retours

this

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

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

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

handler

(meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>

Rappel qui gère les événements de fin de réunion.

Retours

this

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

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

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

handler

(meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>

Rappel qui gère les événements de début de réunion.

Retours

this

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

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

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

handler

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

Rappel permettant de gérer les membres d’équipes ajoutés à l’événement.

Retours

this

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

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

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

handler

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

Rappel permettant de gérer l’événement supprimé par les membres de l’équipe.

Retours

this

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

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

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

handler

(receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Rappel qui gère les événements de confirmation de lecture.

Retours

this

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

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

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

handler

(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Rappel permettant de gérer l’événement archivé par l’équipe teams.

Retours

this

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

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

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

handler

(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Rappel permettant de gérer l’événement supprimé par l’équipe teams.

Retours

this

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

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

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

handler

(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Rappel permettant de gérer l’événement supprimé en dur par l’équipe teams.

Retours

this

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

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

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

handler

(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Rappel permettant de gérer l’événement renommé de l’équipe teams.

Retours

this

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

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

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

handler

(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Rappel permettant de gérer l’événement restauré par l’équipe teams.

Retours

this

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

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

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

handler

(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Rappel permettant de gérer l’événement nonarchivé de l’équipe teams.

Retours

this

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

Détails de la méthode héritée

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 .

Hérité de ActivityHandler.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 .

Hérité de ActivityHandler.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 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é de ActivityHandler.onConversationUpdate

onDialog(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement de boîte 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 .

Hérité de ActivityHandler.onDialog

onEndOfConversation(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour la fin de l’activité 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 spécifique au type onEndOfConversation .

Hérité de ActivityHandler.onEndOfConversation

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é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é de nom de l’activité, 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 tokens/response de sous-type onTokenResponseEvent . Pour gérer d’autres événements nommés, ajoutez une logique à ce gestionnaire.

Hérité de ActivityHandler.onEvent

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 .

Hérité de ActivityHandler.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 .

Hérité de ActivityHandler.onInstallationUpdateAdd

onInstallationUpdateRemove(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’activité de suppression d’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 .

Hérité de ActivityHandler.onInstallationUpdateRemove

onMembersAdded(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement ajouté aux membres , é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

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 .

Hérité de ActivityHandler.onMembersAdded

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 .

Hérité de ActivityHandler.onMembersRemoved

onMessage(BotHandler)

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

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.

Hérité de ActivityHandler.onMessage

onMessageReaction(BotHandler)

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

handler

BotHandler

Gestionnaire d’événements.

Retours

this

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 propriété from représente la source de la réaction, telle que l’utilisateur qui a réagi au message.

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

Hérité de ActivityHandler.onMessageReaction

onReactionsAdded(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement ajouté aux réactions , é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

handler

BotHandler

Gestionnaire d’événements.

Retours

this

Référence à l’objet ActivityHandler .

Remarques

La propriété reactionsAdded de l’activité 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 spécifique au type onMessageReaction .

Hérité de ActivityHandler.onReactionsAdded

onReactionsRemoved(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement supprimé 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é reactionsRemoved 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 spécifique au type onMessageReaction .

Hérité de ActivityHandler.onReactionsRemoved

onTokenResponseEvent(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement tokens-response , émis pour toute activité d’événement entrante tokens/response . Celles-ci sont générées 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é valeur 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, 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 spécifique au type onEvent .

Hérité de ActivityHandler.onTokenResponseEvent

onTurn(BotHandler)

Inscrit un gestionnaire d’événements d’activité pour l’événement de tour , é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 .

Hérité de ActivityHandler.onTurn

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 spécifique au type onTyping .

Hérité de ActivityHandler.onTyping

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 le Gestionnaire d’événements 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

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

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

Hérité de ActivityHandler.onUnrecognizedActivityType

run(TurnContext)

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

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 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 aussi

Hérité de ActivityHandler.run