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

Ein Botadapter, der einen Bot mit einem Dienstendpunkt verbinden kann.

public class BotFrameworkAdapter : Microsoft.Bot.Builder.BotAdapter, Microsoft.Bot.Builder.IExtendedUserTokenProvider, Microsoft.Bot.Builder.Integration.IAdapterIntegration, Microsoft.Bot.Builder.OAuth.IConnectorClientBuilder

type BotFrameworkAdapter = class
    inherit BotAdapter
    interface IAdapterIntegration
    interface IExtendedUserTokenProvider
    interface IUserTokenProvider
    interface IConnectorClientBuilder

Public Class BotFrameworkAdapter
Inherits BotAdapter
Implements IAdapterIntegration, IConnectorClientBuilder, IExtendedUserTokenProvider

Vererbung: Object

BotAdapter
BotFrameworkAdapter

Abgeleitet: Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase

Implementiert: IExtendedUserTokenProvider IAdapterIntegration IUserTokenProvider IConnectorClientBuilder

Hinweise

BotFrameworkAdapter wird weiterhin unterstützt, der empfohlene Adapter ist jedoch "CloudAdapter". 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(IMiddleware), um IMiddleware Objekte zur Middleware-Sammlung des Adapters hinzuzufügen. Der Adapter verarbeitet und leitet eingehende Aktivitäten über die Bot-Middleware-Pipeline an die Logik Ihres Bots 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.

Konstruktoren

BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Initialisiert eine neue Instanz der BotFrameworkAdapter Klasse mithilfe eines Anmeldeinformationsanbieters.
BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Initialisiert eine neue Instanz der BotFrameworkAdapter Klasse mithilfe eines Anmeldeinformationsanbieters.
BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Initialisiert eine neue Instanz der BotFrameworkAdapter Klasse mithilfe eines Anmeldeinformationsanbieters.

Felder

BotIdentityKey	Der Zeichenfolgenwert für den Bot-Identitätsschlüssel. (Geerbt von BotAdapter)
InvokeResponseKey	Der Schlüsselwert für alle InvokeResponseActivity-Elemente, die sich auf "TurnState" benädigen. (Geerbt von BotAdapter)
OAuthScopeKey	Der Zeichenfolgenwert für den OAuth-Bereichsschlüssel. (Geerbt von BotAdapter)

Eigenschaften

AppCredentialMap	Ruft die Zuordnung der Anwendungen zu AppCredentials für diesen Adapter ab.
ChannelProvider	Ruft den Kanalanbieter für diesen Adapter ab.
CredentialProvider	Ruft den Anmeldeinformationsanbieter für diesen Adapter ab.
HttpClient	Ruft den benutzerdefinierten HttpClient für diesen Adapter ab, falls angegeben.
Logger	Ruft den Logger für diesen Adapter ab.
MiddlewareSet	Ruft die Sammlung von Middleware in der Pipeline des Adapters ab. (Geerbt von BotAdapter)
OnTurnError	Dient zum Abrufen oder Festlegen eines Fehlerhandlers, der Ausnahmen in der Middleware oder Anwendung abfangen kann. (Geerbt von BotAdapter)

Methoden

BuildCredentialsAsync(String, String)	Logik zum Erstellen eines AppCredentials Objekts, das zum Abrufen von Token für diesen HttpClient verwendet werden soll.
CanProcessOutgoingActivity(Activity)	Möglichkeit für Unterklassen, sich für die Verarbeitung einer ausgehenden Aktivität zu entscheiden.
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Sendet eine proaktive Nachricht an eine Unterhaltung. (Geerbt von BotAdapter)
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	Sendet eine proaktive Nachricht an eine Unterhaltung. (Geerbt von BotAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	Sendet eine proaktive Nachricht vom Bot an eine Unterhaltung.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Sendet eine proaktive Nachricht vom Bot an eine Unterhaltung.
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	Sendet eine proaktive Nachricht an eine Unterhaltung. (Geerbt von BotAdapter)
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	Sendet eine proaktive Nachricht vom Bot an eine Unterhaltung.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Erstellt eine Unterhaltung im angegebenen Kanal.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Veraltet. Erstellt eine Unterhaltung im angegebenen Kanal. Überladung empfängt eine ConversationReference einschließlich des Mandanten.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Erstellt eine Unterhaltung im angegebenen Kanal.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Veraltet. Erstellt eine Unterhaltung im angegebenen Kanal. Überladung empfängt eine ConversationReference einschließlich des Mandanten.
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Erstellt eine Unterhaltung im angegebenen Kanal. (Geerbt von BotAdapter)
CreateOAuthApiClientAsync(ITurnContext)	Erstellt einen OAuth-Client für den Bot.
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	Erstellt einen OAuth-Client für den Bot mit den Anmeldeinformationen.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Löscht eine vorhandene Aktivität in der Unterhaltung.
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	Entfernt ein Mitglied aus der aktuellen Unterhaltung.
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden.
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden.
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)	Ruft Azure Active Directory-Token für bestimmte Ressourcen für eine konfigurierte Verbindung mithilfe von angepassten AppCredentials ab.
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	Ruft Azure Active Directory-Token für bestimmte Ressourcen in einer konfigurierten Verbindung mithilfe der AppCredentials des Bots ab.
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	Listet die Mitglieder einer bestimmten Aktivität auf.
GetConversationMembersAsync(ITurnContext, CancellationToken)	Listet die Mitglieder der aktuellen Unterhaltung auf.
GetConversationsAsync(ITurnContext, String, CancellationToken)	Listet die Unterhaltungen auf, an denen dieser Bot für einen bestimmten Kanalserver teilgenommen hat. Der Kanalserver gibt Ergebnisse in Seiten zurück, und jede Seite enthält eine `continuationToken`, mit der die nächste Seite der Ergebnisse vom Server abgerufen werden kann.
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken)	Listet die Unterhaltungen auf, an denen dieser Bot für einen bestimmten Kanalserver teilgenommen hat. Der Kanalserver gibt Ergebnisse in Seiten zurück, und jede Seite enthält eine `continuationToken`, mit der die nächste Seite der Ergebnisse vom Server abgerufen werden kann.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	Rufen Sie den unformatierten Anmeldelink ab, der mit angepassten AppCredentials an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Rufen Sie den unformatierten Anmeldelink ab, der mit angepassten AppCredentials an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden, indem Sie die AppCredentials des Bots verwenden.
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden, indem Sie die AppCredentials des Bots verwenden.
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)	Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer mithilfe von angepassten AppCredentials ab.
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer mithilfe der AppCredentials des Bots ab.
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Versucht, das Token für einen Benutzer abzurufen, der sich in einem Anmeldefluss befindet, mithilfe von angepassten AppCredentials.
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	Versucht, das Token für einen Benutzer abzurufen, der sich in einem Anmeldefluss befindet, mithilfe der AppCredentials des Bots.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Erstellt einen Turnkontext und führt die Middlewarepipeline für eine eingehende Aktivität aus.
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	Erstellt einen Turnkontext und führt die Middlewarepipeline für eine eingehende Aktivität aus.
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Benutzerdefinierte Logik zum Senden einer ausgehenden Aktivität. Unterklassen können diese Methode zusammen mit CanProcessOutgoingActivity außer Kraft setzen, um benutzerdefinierte Logik zum Verarbeiten der ausgehenden Aktivität zu haben.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Startet die Aktivitätsverarbeitung für die aktuelle Bot-Turn. (Geerbt von BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	Sendet Aktivitäten an die Unterhaltung.
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Signiert den Benutzer mit dem Tokenserver mit angepassten AppCredentials.
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Meldet den Benutzer mit dem Tokenserver unter Verwendung der AppCredentials des Bots ab.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Ersetzt eine vorhandene Aktivität in der Unterhaltung.
Use(IMiddleware)	Fügt Middleware zur Pipeline des Adapters hinzu.

Explizite Schnittstellenimplementierungen

IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)

Ein Botadapter, der einen Bot mit einem Dienstendpunkt verbinden kann.

Erweiterungsmethoden

UseBotState(BotAdapter, BotState[])	Fügt dem Adapter Middleware hinzu, um ein oder mehrere BotState Objekte im Turnkontext zu registrieren. Die Middleware registriert die Zustandsobjekte im Turnkontext am Anfang jeder Drehung.
UseState(BotAdapter, UserState, ConversationState, Boolean)	Veraltet. Registriert Benutzer- und Unterhaltungsstatusobjekte mit dem Adapter. Diese Objekte werden über die TurnStatedes Turnkontexts verfügbar sein.Get<T>() Methode.
UseStorage(BotAdapter, IStorage)	Fügt dem Adapter Middleware hinzu, um ein IStorage -Objekt im Turnkontext zu registrieren. Die Middleware registriert die Zustandsobjekte im Turnkontext am Anfang jeder Drehung.

Gilt für:

Freigeben über