BotAdapter Klasse

Definition

Namespace:
Microsoft.Bot.Builder
Assembly:
Microsoft.Bot.Builder.dll
Paket:
Microsoft.Bot.Builder v4.22.7

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

public abstract class BotAdapter
type BotAdapter = class
Public MustInherit Class BotAdapter
Vererbung
Object
BotAdapter
Abgeleitet

Hinweise

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.

Nutze sie Use(IMiddleware) , um Objekte zur Middleware-Sammlung deines Adapters hinzuzufügen IMiddleware . Der Adapter verarbeitet und leitet eingehende Aktivitäten über die Bot-Middleware-Pipeline in die Logik deines Bots und führt sie dann wieder heraus. Während jede Aktivität den Bot durchläuft, kann jede Middleware die Aktivität überprüfen und beeinflussen, sowohl bevor als auch nachdem die Bot-Logik ausgeführt wurde.

Konstruktoren

Name Beschreibung
BotAdapter()

Initialisiert eine neue Instanz der BotAdapter-Klasse.

Felder

Name Beschreibung
BotIdentityKey

Der String-Wert für den Bot-Identitätsschlüssel.
InvokeResponseKey

Der Schlüsselwert für jede InvokeResponseActivity, die sich im TurnState befindet.
OAuthScopeKey

Der String-Wert für den OAuth-Scope-Schlüssel.

Eigenschaften

Name Beschreibung
MiddlewareSet

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

Erhält oder setzt einen Fehlerhandler, der Ausnahmen in der Middleware oder Anwendung erkennen kann.

Methoden

Name Beschreibung
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)

Sendet eine proaktive Nachricht an eine Unterhaltung.
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)

Sendet eine proaktive Nachricht an eine Unterhaltung.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)

Sendet eine proaktive Nachricht an eine Unterhaltung.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)

Sendet eine proaktive Nachricht an eine Unterhaltung.
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)

Sendet eine proaktive Nachricht an eine Unterhaltung.
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)

Sendet eine proaktive Nachricht an eine Unterhaltung.
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)

Erstellt eine Unterhaltung im angegebenen Kanal.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)

Wenn eine abgeleitete Klasse überschrieben wird, wird eine vorhandene Aktivität in der Unterhaltung gelöscht.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)

Erstellt einen Turn-Kontext und führt die Middleware-Pipeline für eine eingehende VERTRAUENSWÜRDIGE Aktivität aus.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)

Startet die Aktivitätsverarbeitung für die aktuelle Bot-Turn.
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, werden Aktivitäten an die Unterhaltung gesendet.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)

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

Fügt Middleware zur Pipeline des Adapters hinzu.

Erweiterungsmethoden

Name Beschreibung
UseBotState(BotAdapter, BotState[])

Fügt dem Adapter Middleware hinzu, um ein oder mehrere BotState Objekte im Turn-Kontext zu registrieren. Die Middleware registriert die Zustandsobjekte im Zugkontext zu Beginn jeder Runde.
UseState(BotAdapter, UserState, ConversationState, Boolean)
Veraltet.

Registriert Benutzer- und Konversationszustandsobjekte mit dem Adapter. Diese Objekte sind über die TurnStateMethodeGet<T>() des Zugkontexts verfügbar.
UseStorage(BotAdapter, IStorage)

Fügt dem Adapter Middleware hinzu, um ein IStorage Objekt im Zugkontext zu registrieren. Die Middleware registriert die Zustandsobjekte im Zugkontext zu Beginn jeder Runde.

Gilt für:

Weitere Informationen