ActivityHandler class

Registriert einen Aktivitätsereignishandler für den Befehl Aktivität.

function onCommand(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Verwenden Sie zum Behandeln eines Command-Ereignisses den onCommand- typspezifischen Ereignishandler.

Registriert einen Aktivitätsereignishandler für die CommandResult--Aktivität.

function onCommandResult(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Verwenden Sie zum Behandeln eines CommandResult-Ereignisses den onCommandResult- typspezifischen Ereignishandler.

Registriert einen Aktivitätsereignishandler für das Unterhaltungsupdate Ereignis, das für jede Aktivitätsaktualisierung eingehender Unterhaltungen ausgegeben wird.

function onConversationUpdate(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Unterhaltungsaktualisierungsaktivitäten beschreiben änderungen an den Metadaten einer Unterhaltung, z. B. Titel, Teilnehmer oder andere kanalspezifische Informationen.

Verwenden Sie die "onMembersAdded"- und "onMembersRemoved" Untertypereignishandler, um zu behandeln, wann Mitglieder der Unterhaltung hinzugefügt oder daraus entfernt werden.

Registriert einen Aktivitätsereignishandler für das Dialogfeld Ereignis, das als letztes Ereignis für eine eingehende Aktivität ausgegeben wird.

function onDialog(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Registriert einen Aktivitätsereignishandler für das Ende der Unterhaltung Aktivität.

function onEndOfConversation(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Diese Aktivität wird in der Regel von einer Fähigkeit an einen Skill-Anrufer gesendet, der das Ende dieser bestimmten Kindunterhaltung angibt.

Verwenden Sie zum Behandeln eines Unterhaltungsendes den onEndOfConversation typspezifischen Ereignishandler.

Registriert einen Aktivitätsereignishandler für das Ereignis Ereignis, das für jede eingehende Ereignisaktivität ausgegeben wird.

function onEvent(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Ereignisaktivitäten kommunizieren programmgesteuerte Informationen von einem Client oder Kanal an einen Bot. Die Bedeutung einer Ereignisaktivität wird durch den Namen der Aktivität Eigenschaft definiert, die innerhalb des Bereichs eines Kanals sinnvoll ist. Ereignisaktivitäten sind so konzipiert, dass sowohl interaktive Informationen (z. B. Schaltflächenklicks) als auch nicht interaktive Informationen (z. B. eine Benachrichtigung eines Clients, die automatisch ein eingebettetes Sprachmodell aktualisiert) übertragen werden.

Verwenden Sie den "onTokenResponseEvent" Untertypereignishandler, um ein tokens/response Ereignisereignis zu behandeln. Um andere benannte Ereignisse zu behandeln, fügen Sie diesem Handler Logik hinzu.

Registriert einen Aktivitätsereignishandler für das installationupdate Aktivität.

function onInstallationUpdate(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Um ein InstallationUpdate-Ereignis zu behandeln, verwenden Sie den onInstallationUpdate typspezifischen Ereignishandler.

Registriert einen Aktivitätsereignishandler für das Installationsupdates, um Aktivität hinzuzufügen.

function onInstallationUpdateAdd(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt. Um ein InstallationUpdateAdd-Ereignis zu behandeln, verwenden Sie den onInstallationUpdateAdd typspezifischen Ereignishandler.

Registriert einen Aktivitätsereignishandler für das installationupdate entfernen Aktivität.

function onInstallationUpdateRemove(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Um ein InstallationUpdateRemove-Ereignis zu behandeln, verwenden Sie den onInstallationUpdateRemove typspezifischen Ereignishandler.

Registriert einen Aktivitätsereignishandler für die Mitglieder, die Ereignis hinzugefügt wurden, ausgegeben für alle Aktivitätsaktualisierungen eingehender Unterhaltungen, die Mitglieder enthalten, die der Unterhaltung hinzugefügt wurden.

function onMembersAdded(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Die membersAdded-Eigenschaft der Aktivität enthält die Mitglieder, die der Unterhaltung hinzugefügt wurden, die den Bot enthalten können.

Verwenden Sie zum Behandeln von Unterhaltungsaktualisierungsereignissen im Allgemeinen den onConversationUpdate typspezifischen Ereignishandler.

Registriert einen Aktivitätsereignishandler für die Mitglieder, die Ereignis entfernt wurden, ausgelassen für alle Aktivitätsaktualisierungen eingehender Unterhaltungen, die Mitglieder enthalten, die aus der Unterhaltung entfernt wurden.

function onMembersRemoved(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Die membersRemoved-Eigenschaft der Aktivität enthält die Mitglieder, die aus der Unterhaltung entfernt wurden, die den Bot enthalten können.

Verwenden Sie zum Behandeln von Unterhaltungsaktualisierungsereignissen im Allgemeinen den onConversationUpdate typspezifischen Ereignishandler.

Registriert einen Aktivitätsereignishandler für die Nachricht Ereignis, die für jede aktivität eingehende Nachricht ausgegeben wird.

function onMessage(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Nachrichtenaktivitäten stellen Inhalte dar, die in einer Unterhaltungsschnittstelle angezeigt werden sollen, und können Text, Sprache, interaktive Karten und binäre oder unbekannte Anlagen enthalten. Nicht alle Nachrichtenaktivitäten enthalten Text, der Text der Aktivität Eigenschaft kann null oder undefinedwerden.

Registriert einen Aktivitätsereignishandler für die Nachrichtenreaktion Ereignis, die für jede Eingehende Nachrichtenreaktionsaktivität ausgegeben wird.

function onMessageReaction(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Nachrichtenreaktionsaktivitäten stellen eine soziale Interaktion für eine vorhandene Nachrichtenaktivität innerhalb einer Unterhaltung dar. Die ursprüngliche Aktivität wird durch die replyToId-Eigenschaft der Nachrichtenreaktionsaktivität verwiesen. Die von-Eigenschaft stellt die Quelle der Reaktion dar, z. B. der Benutzer, der auf die Nachricht reagiert hat.

Verwenden Sie die "onReactionsAdded"- und "onReactionsRemoved" Untertyp-Ereignishandlern, um zu behandeln, wann Reaktionen zu Nachrichten in der Unterhaltung hinzugefügt oder aus diesen entfernt werden.

Registriert einen Aktivitätsereignishandler für die Reaktionen, die Ereignis hinzugefügt wurden, ausgelassen für jede Aktivität eingehender Nachrichtenreaktionen, die Reaktionen beschreiben, die einer Nachricht hinzugefügt werden.

function onReactionsAdded(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Die Reaktionen Der Eigenschaft der Aktivität umfasst eine oder mehrere hinzugefügte Reaktionen.

Um Nachrichtenreaktionsereignisse im Allgemeinen zu behandeln, verwenden Sie den onMessageReaction typspezifischen Ereignishandler.

Registriert einen Aktivitätsereignishandler für die entfernten Reaktionen Ereignis, die für alle aktivitäts eingehenden Nachrichtenreaktionen ausgegeben werden, die Reaktionen beschreiben, die aus einer Nachricht entfernt werden.

function onReactionsRemoved(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Die Reaktionen der AktivitätRemoved Eigenschaft umfasst eine oder mehrere Reaktionen, die entfernt wurden.

Um Nachrichtenreaktionsereignisse im Allgemeinen zu behandeln, verwenden Sie den onMessageReaction typspezifischen Ereignishandler.

Registriert einen Aktivitätsereignishandler für das Tokenantwort--Ereignis, das für eingehende tokens/response Ereignisaktivität ausgegeben wird. Diese werden als Teil des OAuth-Authentifizierungsflusses generiert.

function onTokenResponseEvent(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Der Wert der Aktivität Eigenschaft enthält das Benutzertoken.

Wenn Ihr Bot die Authentifizierung mithilfe eines OAuthPrompt- in einem Dialogfeld verarbeitet, muss das Dialogfeld diese Aktivität empfangen, um den Authentifizierungsfluss abzuschließen.

Um andere benannte Ereignisse und Ereignisereignisse im Allgemeinen zu behandeln, verwenden Sie den onEvent- typspezifischen Ereignishandler.

Registriert einen Aktivitätsereignishandler für das turn-Ereignis, das für jede eingehende Aktivität ausgegeben wird, unabhängig vom Typ.

function onTurn(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Registriert einen Aktivitätsereignishandler für die Eingabe Aktivität.

function onTyping(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Verwenden Sie zum Behandeln eines Typing-Ereignisses den "onTyping" typspezifischen Ereignishandlers.

Registriert einen Aktivitätsereignishandler für den nicht erkannten Aktivitätstyp Ereignis, das für eine eingehende Aktivität mit einem Typ ausgegeben wird, für den der ActivityHandler keinen Ereignishandler bereitstellt.

function onUnrecognizedActivityType(handler: BotHandler): this

Parameter

Gibt zurück

Ein Verweis auf das ActivityHandler-Objekt.

Hinweise

Die ActivityHandler definiert keine Ereignisse für alle Aktivitätstypen, die im Bot Framework Activity Schemadefiniert sind. Darüber hinaus können Kanäle und benutzerdefinierte Adapter Aktivitäten mit Typen erstellen, die nicht im Schema enthalten sind. Wenn der Aktivitätshandler ein solches Ereignis empfängt, gibt er ein nicht erkanntes Aktivitätstypereignis aus.

Der Typ Eigenschaft der Aktivität enthält den Aktivitätstyp.

Wird aufgerufen, um den Ereignisemissionensprozess zu initiieren.

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

Parameter

Gibt zurück

Hinweise

In der Regel würden Sie diese Methode als Funktionshandler bereitstellen, den der Adapter aufruft, um die Logik des Bots auszuführen, nachdem die empfangene Aktivität vom Adapter vorverarbeitet und durch jede Middleware weitergeleitet wurde.

Zum Beispiel:

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

Siehe auch

• BotFrameworkAdapter.processActivity