BotFrameworkAdapter Klasse

Referenz

Definition

Namespace:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Paket:: Microsoft.Bot.Builder v4.18.1

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.

Achtung

Use CloudAdapter instead.

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

[System.Obsolete("Use `CloudAdapter` instead.", false)]
public class BotFrameworkAdapter : Microsoft.Bot.Builder.BotAdapter, Microsoft.Bot.Builder.IExtendedUserTokenProvider, Microsoft.Bot.Builder.Integration.IAdapterIntegration, Microsoft.Bot.Builder.OAuth.IConnectorClientBuilder

[<System.Obsolete("Use `CloudAdapter` instead.", false)>]
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

Attribute: ObsoleteAttribute

Implementiert: IExtendedUserTokenProvider IAdapterIntegration IUserTokenProvider IConnectorClientBuilder

Hinweise

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

Verwenden Sie Use(IMiddleware) zum Hinzufügen IMiddleware von Objekten zur Middlewaresammlung Ihres Adapters. Der Adapter verarbeitet und leitet eingehende Aktivitäten durch die Bot-Middlewarepipeline zur Logik Ihres Bots und wieder zurück. 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

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

Felder

BotIdentityKey	Veraltet. Der Zeichenfolgenwert für den Botidentitätsschlüssel. (Geerbt von BotAdapter)
InvokeResponseKey	Veraltet. Der Schlüsselwert für alle InvokeResponseActivity-Elemente, die sich im TurnState-Objekt finden würden. (Geerbt von BotAdapter)
OAuthScopeKey	Veraltet. Der Zeichenfolgenwert für den OAuth-Bereichsschlüssel. (Geerbt von BotAdapter)

Eigenschaften

AppCredentialMap	Veraltet. Ruft die Zuordnung der Anwendungen für diesen Adapter ab AppCredentials .
ChannelProvider	Veraltet. Ruft den Kanalanbieter für diesen Adapter ab.
CredentialProvider	Veraltet. Ruft den Anmeldeinformationsanbieter für diesen Adapter ab.
HttpClient	Veraltet. Ruft den Benutzerdefinierten HttpClient für diesen Adapter ab, falls angegeben.
Logger	Veraltet. Ruft die Protokollierung für diesen Adapter ab.
MiddlewareSet	Veraltet. Ruft die Auflistung der Middleware in der Pipeline des Adapters ab. (Geerbt von BotAdapter)
OnTurnError	Veraltet. Ruft einen Fehlerhandler ab, der Ausnahmen in der Middleware oder Anwendung abfangen kann, oder legt diesen fest. (Geerbt von BotAdapter)

Methoden

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

Explizite Schnittstellenimplementierungen

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

Veraltet.

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

Erweiterungsmethoden

UseBotState(BotAdapter, BotState[])	Veraltet. Fügt dem Adapter Middleware hinzu, um ein oder mehrere BotState Objekte im Turnkontext zu registrieren. Die Middleware registriert die Zustandsobjekte zu Beginn jedes Turns im Turnkontext.
UseState(BotAdapter, UserState, ConversationState, Boolean)	Veraltet. Registriert Benutzer- und Unterhaltungsstatusobjekte beim Adapter. Diese Objekte sind über die .Get<T>()-Methode des turn-Kontexts TurnStateverfügbar.
UseStorage(BotAdapter, IStorage)	Veraltet. Fügt dem Adapter Middleware hinzu, um ein IStorage Objekt im Turnkontext zu registrieren. Die Middleware registriert die Zustandsobjekte zu Beginn jedes Turns im Turnkontext.

Gilt für:

Share via