ActivityHandler Klasse

Referenz

Definition

Namespace:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Paket:: Microsoft.Bot.Builder v4.18.1

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Eine Implementierung der -Schnittstelle, die IBot für weitere Unterklassen vorgesehen ist.

public class ActivityHandler : Microsoft.Bot.Builder.IBot

type ActivityHandler = class
    interface IBot

Public Class ActivityHandler
Implements IBot

Vererbung: Object
ActivityHandler

Abgeleitet: Microsoft.Bot.Builder.Teams.TeamsActivityHandler

Implementiert: IBot

Hinweise

Leiten Sie von dieser Klasse ab, um Code zum Verarbeiten bestimmter Aktivitätstypen einzustecken. Die Vor- und Nachverarbeitung von Activity Objekten kann durch Aufrufen der Basisklassenimplementierung aus der abgeleiteten Klasse hinzugefügt werden.

Konstruktoren

ActivityHandler()

Eine Implementierung der -Schnittstelle, die IBot für weitere Unterklassen vorgesehen ist.

Methoden

CreateInvokeResponse(Object)	Eine InvokeResponse Factory, die den Text für den übergebenen Parameter initialisiert und status gleich OK.
OnAdaptiveCardInvokeAsync(ITurnContext<IInvokeActivity>, AdaptiveCardInvokeValue, CancellationToken)	Wird aufgerufen, wenn dem Bot eine Adaptive Card Action Execute gesendet wird.
OnCommandActivityAsync(ITurnContext<ICommandActivity>, CancellationToken)	Wird aufgerufen, wenn eine Befehlsaktivität empfangen wird, wenn das Basisverhalten von OnTurnAsync(ITurnContext, CancellationToken) verwendet wird. Befehle sind Anforderungen zum Ausführen einer Aktion, und Empfänger reagieren in der Regel mit einer oder mehreren commandResult-Aktivitäten. Es wird auch erwartet, dass Empfänger nicht unterstützte Befehlsaktivitäten explizit ablehnen.
OnCommandResultActivityAsync(ITurnContext<ICommandResultActivity>, CancellationToken)	Wird aufgerufen, wenn eine CommandResult-Aktivität empfangen wird, wenn das Basisverhalten von OnTurnAsync(ITurnContext, CancellationToken) verwendet wird. CommandResult-Aktivitäten können verwendet werden, um das Ergebnis einer Befehlsausführung zu kommunizieren.
OnConversationUpdateActivityAsync(ITurnContext<IConversationUpdateActivity>, CancellationToken)	Wird aufgerufen, wenn eine Konversationsaktualisierungsaktivität vom Kanal empfangen wird, wenn das Basisverhalten von OnTurnAsync(ITurnContext, CancellationToken) verwendet wird. Aktivitäten zum Aktualisieren von Unterhaltungen sind nützlich, wenn es darum geht, darauf zu reagieren, dass Benutzer der Unterhaltung hinzugefügt oder daraus entfernt werden. Ein Bot könnte z. B. auf das Hinzufügen eines Benutzers reagieren, indem er den Benutzer begrüßt. Standardmäßig ruft diese Methode auf OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) , wenn Benutzer hinzugefügt wurden oder OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) benutzer entfernt wurden. Die -Methode überprüft die Member-ID, sodass sie nur auf Updates in Bezug auf andere Member als den Bot selbst reagiert.
OnEndOfConversationActivityAsync(ITurnContext<IEndOfConversationActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um spezifische Logik für EndOfConversation Aktivitäten bereitzustellen, z. B. die Unterhaltungslogik.
OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken)	Wird aufgerufen, wenn eine Ereignisaktivität vom Connector empfangen wird, wenn das Basisverhalten von OnTurnAsync(ITurnContext, CancellationToken) verwendet wird. Ereignisaktivitäten können verwendet werden, um viele verschiedene Dinge zu kommunizieren. Standardmäßig ruft diese Methode auf OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken) , wenn der Name der Aktivität lautet `tokens/response` oder OnEventAsync(ITurnContext<IEventActivity>, CancellationToken) anders lautet. Ein `tokens/response` -Ereignis kann durch eine OAuthCardausgelöst werden.
OnEventAsync(ITurnContext<IEventActivity>, CancellationToken)	Wird aufgerufen, wenn ein anderes Ereignis als `tokens/response` empfangen wird, wenn das Basisverhalten von OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken) verwendet wird. Diese Methode kann optional überschrieben werden, wenn der Bot verschiedene Ereignisse verarbeiten soll. Standardmäßig hat diese Methode keine Auswirkungen.
OnInstallationUpdateActivityAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um aktivitätsspezifische Logik bereitzustellen InstallationUpdate .
OnInstallationUpdateAddAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um spezifische Logik für InstallationUpdate Aktivitäten bereitzustellen, wobei "action" auf "add" festgelegt ist.
OnInstallationUpdateRemoveAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um spezifische Logik für InstallationUpdate Aktivitäten bereitzustellen, wobei "action" auf "remove" festgelegt ist.
OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken)	Wird aufgerufen, wenn eine Aufrufaktivität vom Connector empfangen wird, wenn das Basisverhalten von OnTurnAsync(ITurnContext, CancellationToken) verwendet wird. Aufrufen von Aktivitäten können verwendet werden, um viele verschiedene Dinge zu kommunizieren. Standardmäßig ruft diese Methode aufOnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken), wenn der Name der Aktivität oder `signin/tokenExchange`lautet`signin/verifyState`. Ein `signin/verifyState` - oder `signin/tokenExchange` -Aufruf kann durch eine OAuthCardausgelöst werden.
OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um Logik für den Fall bereitzustellen, dass andere Member als der Bot der Konversation beitreten, z. B. die Willkommenslogik Ihres Bots.
OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um Logik für den Fall bereitzustellen, dass andere Member als der Bot die Konversation verlassen, z. B. die Good-bye-Logik Ihres Bots.
OnMessageActivityAsync(ITurnContext<IMessageActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um spezifische Logik für Message Aktivitäten bereitzustellen, z. B. die Unterhaltungslogik.
OnMessageReactionActivityAsync(ITurnContext<IMessageReactionActivity>, CancellationToken)	Wird aufgerufen, wenn eine Ereignisaktivität vom Connector empfangen wird, wenn das Basisverhalten von OnTurnAsync(ITurnContext, CancellationToken) verwendet wird. Nachrichtenreaktionen entsprechen dem Benutzer, der einer zuvor gesendeten Aktivität ein "Gefällt mir" oder "Traurig" usw. (oft ein Emoji) hinzufügt. Nachrichtenreaktionen werden nur von wenigen Kanälen unterstützt. Die Aktivität, der die Nachrichtenreaktion entspricht, wird in der replyToId-Eigenschaft angegeben. Der Wert dieser Eigenschaft ist die Aktivitäts-ID einer zuvor gesendeten Aktivität, die an den Bot als Antwort eines Sendeaufrufs zurückgegeben wurde.
OnReactionsAddedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um Logik für das Hinzufügen von Reaktionen auf eine vorherige Aktivität zur Konversation bereitzustellen.
OnReactionsRemovedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um Logik dafür bereitzustellen, wenn Reaktionen auf eine vorherige Aktivität aus der Konversation entfernt werden.
OnSearchInvokeAsync(ITurnContext<IInvokeActivity>, SearchInvokeValue, CancellationToken)	Wird aufgerufen, wenn dem Bot eine "invoke"-Aktivität mit dem Namen "application/search" gesendet wird.
OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken)	Wird aufgerufen, wenn ein `signin/verifyState` - oder `signin/tokenExchange` -Ereignis empfangen wird, wenn das Basisverhalten von OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken) verwendet wird. Wenn Sie einen `OAuthPrompt`verwenden, überschreiben Sie diese Methode, um sie Activity an das aktuelle Dialogfeld weiterzuleiten. Standardmäßig hat diese Methode keine Auswirkungen.
OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken)	Wird aufgerufen, wenn ein `tokens/response` Ereignis empfangen wird, wenn das Basisverhalten von OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken) verwendet wird. Wenn Sie einen `OAuthPrompt`verwenden, überschreiben Sie diese Methode, um sie Activity an das aktuelle Dialogfeld weiterzuleiten. Standardmäßig hat diese Methode keine Auswirkungen.
OnTurnAsync(ITurnContext, CancellationToken)	Wird vom Adapter (z. B. ) BotFrameworkAdapterzur Laufzeit aufgerufen, um einen eingehenden Activityzu verarbeiten.
OnTypingActivityAsync(ITurnContext<ITypingActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um spezifische Logik für Typing Aktivitäten bereitzustellen, z. B. die Unterhaltungslogik.
OnUnrecognizedActivityTypeAsync(ITurnContext, CancellationToken)	Wird aufgerufen, wenn eine andere Aktivität als eine Nachricht, ein Unterhaltungsupdate oder ein Ereignis empfangen wird, wenn das Basisverhalten von OnTurnAsync(ITurnContext, CancellationToken) verwendet wird. Bei Überschreibung kann dies möglicherweise auf einen der anderen Aktivitätstypen wie ContactRelationUpdate oder EndOfConversationreagieren. Standardmäßig hat diese Methode keine Auswirkungen.

Gilt für:

Share via