ActivityHandler Klasse

Referenz

Definition

Namespace:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Paket:: Microsoft.Bot.Builder v4.22.7

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 IBot-Schnittstelle, die 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.SharePoint.SharePointActivityHandler

Microsoft.Bot.Builder.Teams.TeamsActivityHandler

Implementiert: IBot

Hinweise

Leiten Sie von dieser Klasse ab, um Code zum Behandeln bestimmter Aktivitätstypen zu verwenden. Vor- und Nachbearbeitung von Activity Objekten können durch Aufrufen der Basisklassenimplementierung aus der abgeleiteten Klasse hinzugefügt werden.

Konstruktoren

ActivityHandler()

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

Methoden

CreateInvokeResponse(Object)	Eine InvokeResponse Factory, die den Textkörper an den übergebenen Parameter initialisiert, und der Status ist gleich OK.
OnAdaptiveCardInvokeAsync(ITurnContext<IInvokeActivity>, AdaptiveCardInvokeValue, CancellationToken)	Wird aufgerufen, wenn der Bot eine Aktion für adaptive Karten 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. Empfänger werden auch erwartet, dass nicht unterstützte Befehlsaktivitäten explizit abgelehnt werden.
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 Unterhaltungsaktualisierungsaktivität vom Kanal empfangen wird, wenn das Basisverhalten von OnTurnAsync(ITurnContext, CancellationToken) verwendet wird. Unterhaltungsaktualisierungsaktivitäten sind nützlich, wenn es darum geht, auf Benutzer zu reagieren, die der Unterhaltung hinzugefügt oder daraus entfernt werden. Beispielsweise könnte ein Bot auf einen Benutzer reagieren, der von der Begrüßung des Benutzers hinzugefügt wird. Standardmäßig ruft diese Methode OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) auf, wenn Benutzer hinzugefügt oder OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) wurden, wenn Benutzer entfernt wurden. Die Methode überprüft die Member-ID, sodass sie nur auf Aktualisierungen in Bezug auf andere Member als den Bot selbst reagiert.
OnEndOfConversationActivityAsync(ITurnContext<IEndOfConversationActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch 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 OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken) auf, wenn der Name der Aktivität `tokens/response` oder andernfalls OnEventAsync(ITurnContext<IEventActivity>, CancellationToken) ist. 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 außer Kraft gesetzt werden, wenn der Bot verschiedene Ereignisse behandeln soll. Standardmäßig führt diese Methode nichts aus.
OnInstallationUpdateActivityAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für InstallationUpdate Aktivitäten bereitzustellen.
OnInstallationUpdateAddAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für InstallationUpdate Aktivitäten bereitzustellen, wobei "action" auf "add" festgelegt ist.
OnInstallationUpdateRemoveAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch 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. Aufrufaktivitäten können verwendet werden, um viele verschiedene Dinge zu kommunizieren. Standardmäßig ruft diese Methode OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken) auf, wenn der Name der Aktivität `signin/verifyState` oder `signin/tokenExchange`ist. 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 bereitzustellen, wenn andere Mitglieder als der Bot der Unterhaltung beitreten, z. B. die Willkommenslogik Ihres Bots.
OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um Logik bereitzustellen, wenn andere Member als der Bot die Unterhaltung verlassen, z. B. die Gute-Bye-Logik Ihres Bots.
OnMessageActivityAsync(ITurnContext<IMessageActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für Message Aktivitäten bereitzustellen, z. B. die Unterhaltungslogik.
OnMessageDeleteActivityAsync(ITurnContext<IMessageDeleteActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für MessageDelete 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 eine "Gefällt mir" oder "traurig" usw. (oft ein Emoji) zu einer zuvor gesendeten Aktivität 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 dem Bot als Antwort von einem Sendeaufruf zurückgegeben wurde.
OnMessageUpdateActivityAsync(ITurnContext<IMessageUpdateActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für MessageUpdate Aktivitäten bereitzustellen, z. B. die Unterhaltungslogik.
OnReactionsAddedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um Logik bereitzustellen, wenn Reaktionen auf eine vorherige Aktivität der Unterhaltung hinzugefügt werden.
OnReactionsRemovedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um Logik bereitzustellen, wenn Reaktionen auf eine vorherige Aktivität aus der Unterhaltung entfernt werden.
OnSearchInvokeAsync(ITurnContext<IInvokeActivity>, SearchInvokeValue, CancellationToken)	Wird aufgerufen, wenn der 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 eine `OAuthPrompt`verwenden, setzen Sie diese Methode außer Kraft, um diese Activity an das aktuelle Dialogfeld weiterzuleiten. Standardmäßig führt diese Methode nichts aus.
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 eine `OAuthPrompt`verwenden, setzen Sie diese Methode außer Kraft, um diese Activity an das aktuelle Dialogfeld weiterzuleiten. Standardmäßig führt diese Methode nichts aus.
OnTurnAsync(ITurnContext, CancellationToken)	Wird vom Adapter (z. B. ein BotFrameworkAdapter) zur Laufzeit aufgerufen, um eine eingehende Activityzu verarbeiten.
OnTypingActivityAsync(ITurnContext<ITypingActivity>, CancellationToken)	Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für Typing Aktivitäten bereitzustellen, z. B. die Unterhaltungslogik.
OnUnrecognizedActivityTypeAsync(ITurnContext, CancellationToken)	Wird aufgerufen, wenn eine andere Aktivität als eine Nachricht, Unterhaltungsaktualisierung oder ein Ereignis empfangen wird, wenn das Basisverhalten von OnTurnAsync(ITurnContext, CancellationToken) verwendet wird. Wenn dies außer Kraft gesetzt wird, kann dies möglicherweise auf einen der anderen Aktivitätstypen wie ContactRelationUpdate oder EndOfConversationreagieren. Standardmäßig führt diese Methode nichts aus.

Gilt für: