ActivityHandler Klasse

public ActivityHandler()

protected InvokeResponse createInvokeResponse(Object body)

Erstellt einen erfolgreichen InvokeResponse-Wert mit dem angegebenen Textkörper.

Parameter:

Gibt zurück:

protected CompletableFuture onAdaptiveCardInvoke(TurnContext turnContext, AdaptiveCardInvokeValue invokeValue)

Wird aufgerufen, wenn der Bot eine Aktion für adaptive Karten gesendet wird.

Parameter:

Gibt zurück:

protected CompletableFuture onCommandActivity(TurnContext turnContext)

Wird aufgerufen, wenn eine Befehlsaktivität empfangen wird, wenn das Basisverhalten von onTurn(TurnContext turnContext) 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.

Parameter:

Gibt zurück:

protected CompletableFuture onCommandResultActivity(TurnContext turnContext)

Wird aufgerufen, wenn eine CommandResult-Aktivität empfangen wird, wenn das Basisverhalten von onTurn(TurnContext turnContext) verwendet wird. CommandResult-Aktivitäten können verwendet werden, um das Ergebnis einer Befehlsausführung zu kommunizieren.

Parameter:

Gibt zurück:

protected CompletableFuture onConversationUpdateActivity(TurnContext turnContext)

Wird aufgerufen, wenn eine Unterhaltungsaktualisierungsaktivität vom Kanal empfangen wird, wenn das Basisverhalten von onTurn(TurnContext turnContext) 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 onMembersAdded(List<ChannelAccount> membersAdded, TurnContext turnContext) auf, wenn Benutzer hinzugefügt oder onMembersRemoved(List<ChannelAccount> membersRemoved, TurnContext turnContext) 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.

Parameter:

Gibt zurück:

protected CompletableFuture onEndOfConversationActivity(TurnContext turnContext)

Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.END_OF_CONVERSATION Aktivitäten bereitzustellen.

Parameter:

Gibt zurück:

protected CompletableFuture onEvent(TurnContext turnContext)

Wird aufgerufen, wenn ein anderes Ereignis als Token/Antwort empfangen wird, wenn das Basisverhalten von onEventActivity(TurnContext turnContext) 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.

Wenn die onEventActivity(TurnContext turnContext)-Methode ein Ereignis mit einer anderen Activity#getName() als "Token/Antwort" empfängt, ruft sie diese Methode auf.

Parameter:

Gibt zurück:

protected CompletableFuture onEventActivity(TurnContext turnContext)

Wird aufgerufen, wenn eine Ereignisaktivität vom Connector empfangen wird, wenn das Basisverhalten von onTurn(TurnContext turnContext) verwendet wird.

Ereignisaktivitäten können verwendet werden, um viele verschiedene Dinge zu kommunizieren.

Standardmäßig ruft diese Methode onTokenResponseEvent(TurnContext turnContext) auf, wenn der Name der Aktivität "Token/Antwort" lautet oder andernfalls onEvent(TurnContext turnContext). Das Ereignis "token/response" kann durch eine com.microsoft.bot.schema.OAuthCardausgelöst werden.

Wenn die onTurn(TurnContext turnContext)-Methode eine Ereignisaktivität empfängt, ruft sie diese Methode auf.

Wenn das Ereignis Activity#getName "Token/Antwort" ist, ruft es onTokenResponseEvent(TurnContext turnContext) andernfalls auf, wird onEvent(TurnContext turnContext)aufgerufen.

Überschreiben Sie in einer abgeleiteten Klasse diese Methode, um Logik hinzuzufügen, die für alle Ereignisaktivitäten gilt. Fügen Sie vor dem Aufruf der Basisklassenmethode Logik hinzu, die vor der spezifischen Ereignisbehandlungslogik angewendet werden soll. Fügen Sie logik hinzu, die nach dem Aufruf der Basisklassenmethode nach der spezifischen Ereignisbehandlungslogik angewendet werden soll.

Ereignisaktivitäten kommunizieren programmgesteuerte Informationen von einem Client oder Kanal an einen Bot. Die Bedeutung einer Ereignisaktivität wird durch die Activity#getName-Eigenschaft definiert, die innerhalb des Bereichs eines Kanals aussagekräftig ist. Ein "token/response"-Ereignis kann durch eine com.microsoft.bot.schema.OAuthCard oder eine OAuth-Eingabeaufforderung ausgelöst werden.

Parameter:

Gibt zurück:

protected CompletableFuture onInstallationUpdate(TurnContext turnContext)

Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.InstallationUpdate-Aktivitäten bereitzustellen.

Parameter:

Gibt zurück:

protected CompletableFuture onInstallationUpdateAdd(TurnContext turnContext)

Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.InstallationUpdate-Aktivitäten bereitzustellen, wobei "action" auf "add" festgelegt ist.

Parameter:

Gibt zurück:

protected CompletableFuture onInstallationUpdateRemove(TurnContext turnContext)

Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.InstallationUpdate-Aktivitäten bereitzustellen, wobei "action" auf "remove" festgelegt ist.

Parameter:

Gibt zurück:

protected CompletableFuture onInvokeActivity(TurnContext turnContext)

Wird aufgerufen, wenn eine Aufrufaktivität vom Connector empfangen wird, wenn das Basisverhalten von onTurn verwendet wird.

Aufrufaktivitäten können verwendet werden, um viele verschiedene Dinge zu kommunizieren. Standardmäßig ruft diese Methode onSignInInvokeAsync auf, wenn der Name der Aktivität "signin/verifyState" oder "signin/tokenExchange" lautet.

Ein Aufruf von "signin/verifyState" oder "signin/tokenExchange" kann von einer OAuthCard ausgelöst werden.

Parameter:

Gibt zurück:

protected CompletableFuture onMembersAdded(List membersAdded, TurnContext turnContext)

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

Wenn die onConversationUpdateActivity(TurnContext turnContext)-Methode eine Unterhaltungsaktualisierungsaktivität empfängt, die angibt, dass ein oder mehrere andere Benutzer als die Bo an der Unterhaltung teilnehmen, wird diese Methode aufgerufen.

Parameter:

Gibt zurück:

protected CompletableFuture onMembersRemoved(List membersRemoved, TurnContext turnContext)

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

Wenn die onConversationUpdateActivity(TurnContext turnContext)-Methode eine Unterhaltungsaktualisierungsaktivität empfängt, die angibt, dass mindestens ein anderer Benutzer als der Bot die Unterhaltung verlässt, wird diese Methode aufgerufen.

Parameter:

Gibt zurück:

protected CompletableFuture onMessageActivity(TurnContext turnContext)

Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes#MESSAGE Aktivitäten bereitzustellen, z. B. die Unterhaltungslogik.

Wenn die onTurn(TurnContext turnContext)-Methode eine Nachrichtenaktivität empfängt, ruft sie diese Methode auf.

Parameter:

Gibt zurück:

protected CompletableFuture onMessageReactionActivity(TurnContext turnContext)

Wird aufgerufen, wenn eine Ereignisaktivität vom Connector empfangen wird, wenn das Basisverhalten von onTurn(TurnContext turnContext) 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.

Wenn die onTurn(TurnContext turnContext)-Methode eine Nachrichtenreaktionsaktivität empfängt, ruft sie diese Methode auf. Wenn die Nachrichtenreaktion angibt, dass Reaktionen zu einer Nachricht hinzugefügt wurden, ruft sie onReactionsAdded(List<MessageReaction> messageReactions, TurnContext turnContext)auf. Wenn die Nachrichtenreaktion angibt, dass Reaktionen aus einer Nachricht entfernt wurden, ruft sie onReactionsRemoved(List<MessageReaction> messageReactions, TurnContext turnContext)auf.

Überschreiben Sie in einer abgeleiteten Klasse diese Methode, um Logik hinzuzufügen, die für alle Nachrichtenreaktionsaktivitäten gilt. Fügen Sie logik hinzu, die angewendet werden soll, bevor die Reaktionen vor dem Aufruf der Basisklassenmethode hinzugefügt oder entfernt wurden. Fügen Sie logik hinzu, die nach dem Aufruf der Basisklasse nach dem Aufruf der Basisklasse angewendet werden soll, nachdem die Reaktionen hinzugefügt oder entfernt wurden.

Parameter:

Gibt zurück:

protected CompletableFuture onReactionsAdded(List messageReactions, TurnContext turnContext)

Überschreiben Sie dies in einer abgeleiteten Klasse, um Logik bereitzustellen, wenn Reaktionen auf eine vorherige Aktivität der Unterhaltung hinzugefügt werden.

Nachrichtenreaktionen entsprechen dem Benutzer, der eine "Gefällt mir" oder "traurig" usw. (oft ein Emoji) zu einer zuvor gesendeten Nachricht in der Unterhaltung hinzufügt. Nachrichtenreaktionen werden nur von wenigen Kanälen unterstützt. Die Aktivität, auf die die Nachricht reagiert, wird durch die Activity#getReplyToId() Eigenschaft der Aktivität identifiziert. Der Wert dieser Eigenschaft ist die Aktivitäts-ID einer zuvor gesendeten Aktivität. Wenn der Bot eine Aktivität sendet, weist der Kanal ihm eine ID zu, die im com.microsoft.bot.schema.ResourceResponse#getId des Ergebnisses verfügbar ist.

Parameter:

Gibt zurück:

protected CompletableFuture onReactionsRemoved(List messageReactions, TurnContext turnContext)

Überschreiben Sie dies in einer abgeleiteten Klasse, um Logik bereitzustellen, wenn Reaktionen auf eine vorherige Aktivität aus der Unterhaltung entfernt werden.

Nachrichtenreaktionen entsprechen dem Benutzer, der eine "Gefällt mir" oder "traurig" usw. (oft ein Emoji) zu einer zuvor gesendeten Nachricht in der Unterhaltung hinzufügt. Nachrichtenreaktionen werden nur von wenigen Kanälen unterstützt. Die Aktivität, auf die die Nachricht reagiert, wird durch die Activity#getReplyToId() Eigenschaft der Aktivität identifiziert. Der Wert dieser Eigenschaft ist die Aktivitäts-ID einer zuvor gesendeten Aktivität. Wenn der Bot eine Aktivität sendet, weist der Kanal ihm eine ID zu, die im com.microsoft.bot.schema.ResourceResponse#getId des Ergebnisses verfügbar ist.

Parameter:

Gibt zurück:

protected CompletableFuture onSignInInvoke(TurnContext turnContext)

Wird aufgerufen, wenn ein "signin/verifyState"- oder "signin/tokenExchange"-Ereignis empfangen wird, wenn das Basisverhalten von "onInvokeActivity" verwendet wird.

Wenn Sie eine OAuthPrompt verwenden, überschreiben Sie diese Methode, um diese Aktivität an das aktuelle Dialogfeld weiterzuleiten. Standardmäßig führt diese Methode nichts aus.

Wenn die onInvokeActivity-Methode einen Aufruf mit dem Namen "token/response" empfängt, ruft sie diese Methode auf.

Wenn Ihr Bot OAuthPrompt verwendet, leiten Sie die eingehende Aktivität an das aktuelle Dialogfeld weiter.

Parameter:

Gibt zurück:

protected CompletableFuture onTokenResponseEvent(TurnContext turnContext)

Wird aufgerufen, wenn ein "token/response"-Ereignis empfangen wird, wenn das Basisverhalten von onEventActivity(TurnContext turnContext) verwendet wird.

Wenn Sie eine OAuthPrompt verwenden, überschreiben Sie diese Methode, um diese Activity an das aktuelle Dialogfeld weiterzuleiten.

Standardmäßig führt diese Methode nichts aus.

Wenn die onEventActivity(TurnContext turnContext)-Methode ein Ereignis mit einer Activity#getName() von "Tokens/Response" empfängt, ruft sie diese Methode auf.

Parameter:

Gibt zurück:

public CompletableFuture onTurn(TurnContext turnContext)

Wird vom Adapter (z. B. ein BotFrameworkAdapter) zur Laufzeit aufgerufen, um eine eingehende Activityzu verarbeiten.

Diese Methode ruft andere Methoden in dieser Klasse basierend auf dem Typ der zu verarbeitenden Aktivität auf, wodurch eine abgeleitete Klasse typspezifische Logik auf kontrollierte Weise bereitstellen kann.

Überschreiben Sie in einer abgeleiteten Klasse diese Methode, um Logik hinzuzufügen, die für alle Aktivitätstypen gilt. Fügen Sie vor dem Aufruf der Basisklasse onTurn(TurnContext turnContext) Methode Logik hinzu, die vor der typspezifischen Logik angewendet werden soll. Fügen Sie logik hinzu, die nach dem Aufruf der Basisklasse onTurn(TurnContext turnContext) Methode nach der typspezifischen Logik angewendet werden soll.

Parameter:

Gibt zurück:

protected CompletableFuture onTypingActivity(TurnContext turnContext)

Überschreiben Sie dies in einer abgeleiteten Klasse, um logikspezifisch für ActivityTypes.Typing-Aktivitäten bereitzustellen.

Parameter:

Gibt zurück:

protected CompletableFuture onUnrecognizedActivityType(TurnContext turnContext)

Wird aufgerufen, wenn eine andere Aktivität als eine Nachricht, Unterhaltungsaktualisierung oder ein Ereignis empfangen wird, wenn das Basisverhalten von onTurn(TurnContext turnContext) verwendet wird.

Wenn dies außer Kraft gesetzt wird, kann dies möglicherweise auf einen der anderen Aktivitätstypen wie com.microsoft.bot.schema.ActivityTypes#CONTACT_RELATION_UPDATE oder com.microsoft.bot.schema.ActivityTypes#END_OF_CONVERSATIONreagieren.

Standardmäßig führt diese Methode nichts aus.

Wenn die onTurn(TurnContext turnContext)-Methode eine Aktivität empfängt, die keine Nachricht, Unterhaltungsaktualisierung, Nachrichtenreaktion oder Ereignisaktivität ist, wird diese Methode aufgerufen.

Parameter:

Gibt zurück: