Freigeben über

BotAdapter Klasse

  • Referenz
Paket:
com.microsoft.bot.builder
Maven-Artefakt:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.BotAdapter

public abstract class BotAdapter

Stellt einen Botadapter dar, der einen Bot mit einem Dienstendpunkt verbinden kann. Diese Klasse ist abstrakt.

Der Botadapter kapselt Authentifizierungsprozesse und sendet Aktivitäten an und empfängt Aktivitäten vom Bot Connector-Dienst. Wenn Ihr Bot eine Aktivität empfängt, erstellt der Adapter ein Kontextobjekt, übergibt es an die Anwendungslogik Ihres Bots und sendet Antworten an den Kanal des Benutzers.

Verwenden Sie use(Middleware middleware), um ihrem Adapter\u2019Middleware-Auflistung Middleware Objekte hinzuzufügen. Der Adapter verarbeitet und leitet eingehende Aktivitäten über die Bot-Middleware-Pipeline an Ihren Bot\u2019Logik weiter und wieder heraus. Da jede Aktivität in und aus dem Bot fließt, kann jeder Teil der Middleware die Aktivität sowohl vor als auch nach ausführung der Botlogik überprüfen oder darauf reagieren.

TurnContext Activity Bot Middleware

Feldzusammenfassung

Modifizierer und Typ Feld und Beschreibung
static final java.lang.String BOT_IDENTITY_KEY

Schlüssel zum Speichern der Bot-Anspruchsidentität.
static final java.lang.String OAUTH_CLIENT_KEY

Schlüssel zum Speichern des Bot oauth-Clients.
static final java.lang.String OAUTH_SCOPE_KEY

Schlüssel zum Speichern des Oauth-Bereichs des Bots.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
BotAdapter()

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

Sendet eine proaktive Nachricht an eine Unterhaltung.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

Sendet eine proaktive Nachricht an eine Unterhaltung.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Sendet eine proaktive Nachricht an eine Unterhaltung.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Sendet eine proaktive Nachricht an eine Unterhaltung.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

Sendet eine proaktive Nachricht an eine Unterhaltung.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Sendet eine proaktive Nachricht an eine Unterhaltung.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(TurnContext context, ConversationReference reference)

Wenn eine abgeleitete Klasse überschrieben wird, wird eine vorhandene Aktivität in der Unterhaltung gelöscht.
protected MiddlewareSet getMiddlewareSet()

Ruft die Sammlung von Middleware in der Pipeline des Adapters ab.
OnTurnErrorHandler getOnTurnError()

Ruft den Fehlerhandler ab, der Ausnahmen in der Middleware oder Anwendung abfangen kann.
protected java.util.concurrent.CompletableFuture<java.lang.Void> runPipeline(TurnContext context, BotCallbackHandler callback)

Startet die Aktivitätsverarbeitung für die aktuelle Bot-Turn.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(TurnContext context, List<Activity> activities)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, werden Aktivitäten an die Unterhaltung gesendet.
void setOnTurnError(OnTurnErrorHandler withTurnError)

Legt den Fehlerhandler fest, der Ausnahmen in der Middleware oder Anwendung abfangen kann.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(TurnContext context, Activity activity)

Wenn sie in einer abgeleiteten Klasse außer Kraft gesetzt wird, wird eine vorhandene Aktivität in der Unterhaltung ersetzt.
BotAdapter use(Middleware middleware)

Fügt Middleware zur Pipeline des Adapters hinzu.

Geerbte Methoden von java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Felddetails

BOT_IDENTITY_KEY

public static final String BOT_IDENTITY_KEY

Schlüssel zum Speichern der Bot-Anspruchsidentität.

OAUTH_CLIENT_KEY

public static final String OAUTH_CLIENT_KEY

Schlüssel zum Speichern des Bot oauth-Clients.

OAUTH_SCOPE_KEY

public static final String OAUTH_SCOPE_KEY

Schlüssel zum Speichern des Oauth-Bereichs des Bots.

Details zum Konstruktor

BotAdapter

public BotAdapter()

Details zur Methode

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

Sendet eine proaktive Nachricht an eine Unterhaltung.

Rufen Sie diese Methode auf, um proaktiv eine Nachricht an eine Unterhaltung zu senden. Die meisten Kanäle erfordern, dass ein Benutzer eine Unterhaltung mit einem Bot initiiert, bevor der Bot Aktivitäten an den Benutzer senden kann.

Parameter:

claimsIdentity - Ein ClaimsIdentity für die Unterhaltung.
continuationActivity - Eine Aktivität mit der entsprechenden ConversationReference, mit der die Unterhaltung fortgesetzt werden soll.
callback - Die Methode, die für die Ergebnisbot-Turn aufgerufen werden soll.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

Sendet eine proaktive Nachricht an eine Unterhaltung.

Rufen Sie diese Methode auf, um proaktiv eine Nachricht an eine Unterhaltung zu senden. Die meisten Kanäle erfordern, dass ein Benutzer eine Unterhaltung mit einem Bot initiiert, bevor der Bot Aktivitäten an den Benutzer senden kann.

Parameter:

claimsIdentity - Ein ClaimsIdentity für die Unterhaltung.
continuationActivity - Eine Aktivität mit der entsprechenden ConversationReference, mit der die Unterhaltung fortgesetzt werden soll.
audience - Ein Wert, der den Empfänger der proaktiven Nachricht angibt.
callback - Die Methode, die für die Ergebnisbot-Turn aufgerufen werden soll.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Sendet eine proaktive Nachricht an eine Unterhaltung.

Rufen Sie diese Methode auf, um proaktiv eine Nachricht an eine Unterhaltung zu senden. Die meisten Kanäle erfordern, dass ein Benutzer eine Unterhaltung mit einem Bot initiiert, bevor der Bot Aktivitäten an den Benutzer senden kann.

Parameter:

claimsIdentity - Ein ClaimsIdentity-Verweis für die Unterhaltung.
reference - Ein Verweis auf die Unterhaltung, um fortzufahren.
callback - Die Methode, die für die Ergebnisbot-Turn aufgerufen werden soll.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Sendet eine proaktive Nachricht an eine Unterhaltung.

Rufen Sie diese Methode auf, um proaktiv eine Nachricht an eine Unterhaltung zu senden. Die meisten Kanäle erfordern, dass ein Benutzer eine Unterhaltung mit einem Bot initiiert, bevor der Bot Aktivitäten an den Benutzer senden kann.

Parameter:

claimsIdentity - Ein ClaimsIdentity-Verweis für die Unterhaltung.
reference - Ein Verweis auf die Unterhaltung, um fortzufahren.
audience - Ein Wert, der den Empfänger der proaktiven Nachricht angibt.
callback - Die Methode, die für die Ergebnisbot-Turn aufgerufen werden soll.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

continueConversation

public CompletableFuture continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

Sendet eine proaktive Nachricht an eine Unterhaltung.

Rufen Sie diese Methode auf, um proaktiv eine Nachricht an eine Unterhaltung zu senden. Die meisten Kanäle erfordern, dass ein Benutzer eine Unterhaltung mit einem Bot initiiert, bevor der Bot Aktivitäten an den Benutzer senden kann.

Parameter:

botId - Die Anwendungs-ID des Bots. Dieser Parameter wird in einem einzigen Mandanten ignoriert, die Adapter (Konsole, Test usw.) sind für den BotFrameworkAdapter wichtig, der multimandantenfähig ist.
continuationActivity - Eine Aktivität mit der entsprechenden ConversationReference, mit der die Unterhaltung fortgesetzt werden soll.
callback - Die Methode, die für die Ergebnisbot-Turn aufgerufen werden soll.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

continueConversation

public CompletableFuture continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Sendet eine proaktive Nachricht an eine Unterhaltung.

Parameter:

botAppId - Die Anwendungs-ID des Bots. Dieser Parameter wird in einem einzigen Mandanten ignoriert, die Adapter (Konsole, Test usw.) sind für den BotFrameworkAdapter wichtig, der multimandantenfähig ist.
reference - Ein Verweis auf die Unterhaltung, um fortzufahren.
callback - Die Methode, die für die resultierende Bot-Turn aufgerufen werden soll.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt. Rufen Sie diese Methode auf, um proaktiv eine Nachricht an eine Unterhaltung zu senden. Die meisten Kanäle erfordern, dass ein Benutzer eine Unterhaltung mit einem Bot initiiert, bevor der Bot Aktivitäten an den Benutzer senden kann. 
     <xref uid="com.microsoft.bot.builder.BotAdapter.runPipeline(com.microsoft.bot.builder.TurnContext,com.microsoft.bot.builder.BotCallbackHandler)" data-throw-if-not-resolved="false" data-raw-source="#runPipeline(TurnContext, BotCallbackHandler)"></xref>

deleteActivity

public abstract CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

Wenn eine abgeleitete Klasse überschrieben wird, wird eine vorhandene Aktivität in der Unterhaltung gelöscht.

Parameter:

context - Das Kontextobjekt für die Drehung.
reference - Unterhaltungsverweis für die zu löschende Aktivität.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt. Die ConversationReference#getActivityId der Unterhaltungsreferenz identifiziert die zu löschende Aktivität. onDeleteActivity(DeleteActivityHandler handler)

getMiddlewareSet

protected MiddlewareSet getMiddlewareSet()

Ruft die Sammlung von Middleware in der Pipeline des Adapters ab.

Gibt zurück:

Die Middleware-Sammlung für die Pipeline.

getOnTurnError

public OnTurnErrorHandler getOnTurnError()

Ruft den Fehlerhandler ab, der Ausnahmen in der Middleware oder Anwendung abfangen kann.

Gibt zurück:

Ein Fehlerhandler, der Ausnahmen in der Middleware oder Anwendung abfangen kann.

runPipeline

protected CompletableFuture runPipeline(TurnContext context, BotCallbackHandler callback)

Startet die Aktivitätsverarbeitung für die aktuelle Bot-Turn. Der Adapter ruft Middleware in der Reihenfolge auf, in der Sie ihn hinzugefügt haben. Der Adapter übergibt das Kontextobjekt für die Drehung und einen nächsten Delegaten, und die Middleware ruft den Delegaten auf, um die Steuerung an die nächste Middleware in der Pipeline zu übergeben. Sobald das Steuerelement das Ende der Pipeline erreicht hat, ruft der Adapter die callback-Methode auf. Wenn eine Middlewarekomponente den nächsten Delegat nicht aufruft, ruft der Adapter keine der nachfolgenden Middleware-\u2019onTurn(TurnContext turnContext, NextDelegate next) Methoden oder der Rückrufmethode und die Pipeline-Kurzschlüsse auf.

Wenn die Drehung durch eine Benutzeraktivität (reaktives Messaging) initiiert wird, ist die Rückrufmethode ein Verweis auf die onTurn(TurnContext turnContext)-Methode des Bots. Wenn die Drehung durch einen Aufruf von continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) (proaktives Messaging) initiiert wird, ist die Rückrufmethode die Rückrufmethode, die im Aufruf bereitgestellt wurde.

Parameter:

context - Das Kontextobjekt der Drehung.
callback - Eine Rückrufmethode, die am Ende der Pipeline ausgeführt werden soll.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

sendActivities

public abstract CompletableFuture sendActivities(TurnContext context, List activities)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, werden Aktivitäten an die Unterhaltung gesendet.

Parameter:

context - Das Kontextobjekt für die Drehung.
activities - Die zu sendenden Aktivitäten.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt. Wenn die Aktivitäten erfolgreich gesendet werden, enthält das Aufgabenergebnis ein Array von ResourceResponse Objekten, die die IDs enthalten, die dem empfangenden Kanal den Aktivitäten zugewiesen wurden. onSendActivities(SendActivitiesHandler handler)

setOnTurnError

public void setOnTurnError(OnTurnErrorHandler withTurnError)

Legt den Fehlerhandler fest, der Ausnahmen in der Middleware oder Anwendung abfangen kann.

Parameter:

withTurnError - Ein Fehlerhandler, der Ausnahmen in der Middleware oder Anwendung abfangen kann.

updateActivity

public abstract CompletableFuture updateActivity(TurnContext context, Activity activity)

Wenn sie in einer abgeleiteten Klasse außer Kraft gesetzt wird, wird eine vorhandene Aktivität in der Unterhaltung ersetzt.

Parameter:

context - Das Kontextobjekt für die Drehung.
activity - Neue Ersetzungsaktivität.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt. Wenn die Aktivität erfolgreich gesendet wird, enthält das Aufgabenergebnis ein ResourceResponse Objekt mit der ID, die der empfangende Kanal der Aktivität zugewiesen hat.

Legen Sie vor dem Aufrufen die ID der Ersetzungsaktivität auf die ID der zu ersetzenden Aktivität fest. onUpdateActivity(UpdateActivityHandler handler)

use

public BotAdapter use(Middleware middleware)

Fügt Middleware zur Pipeline des Adapters hinzu.

Parameter:

middleware - Die hinzuzufügende Middleware.

Gibt zurück:

Das aktualisierte Adapterobjekt. Middleware wird dem Adapter zur Initialisierungszeit hinzugefügt. Für jede Drehung ruft der Adapter Middleware in der Reihenfolge auf, in der Sie ihn hinzugefügt haben.

Gilt für: