BotFrameworkHttpAdapter Klasse
Definition
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.
Eine Bot Builder Adapter-Implementierung, die zur Verarbeitung von HTTP-Anfragen des Bot-Frameworks verwendet wird.
public class BotFrameworkHttpAdapter : Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase, Microsoft.Bot.Builder.Integration.AspNet.WebApi.IBotFrameworkHttpAdapter
type BotFrameworkHttpAdapter = class
inherit BotFrameworkHttpAdapterBase
interface IBotFrameworkHttpAdapter
Public Class BotFrameworkHttpAdapter
Inherits BotFrameworkHttpAdapterBase
Implements IBotFrameworkHttpAdapter
- Vererbung
- Implementiert
Konstruktoren
| Name | Beschreibung |
|---|---|
| BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, HttpClient, ILogger<BotFrameworkHttpAdapter>) |
Initialisiert eine neue Instanz der BotFrameworkHttpAdapter-Klasse. |
| BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, ILogger<BotFrameworkHttpAdapter>) |
Initialisiert eine neue Instanz der BotFrameworkHttpAdapter-Klasse. |
Felder
| Name | Beschreibung |
|---|---|
| BotIdentityKey |
Der String-Wert für den Bot-Identitätsschlüssel. (Geerbt von BotAdapter) |
| InvokeResponseKey |
Der Schlüsselwert für jede InvokeResponseActivity, die sich im TurnState befindet. (Geerbt von BotAdapter) |
| OAuthScopeKey |
Der String-Wert für den OAuth-Scope-Schlüssel. (Geerbt von BotAdapter) |
Eigenschaften
| Name | Beschreibung |
|---|---|
| AppCredentialMap |
Es bekommt die Anwendungskarte AppCredentials für diesen Adapter. (Geerbt von BotFrameworkAdapter) |
| ChannelProvider |
Ruft den Kanalanbieter für diesen Adapter ab. (Geerbt von BotFrameworkAdapter) |
| ClaimsIdentity |
Erhält oder setzt die Schadensidentität für diesen Adapter. (Geerbt von BotFrameworkHttpAdapterBase) |
| ConnectedBot |
Der Bot wird an diesen Adapter angeschlossen oder eingestellt. (Geerbt von BotFrameworkHttpAdapterBase) |
| CredentialProvider |
Ruft den Anmeldeinformationsanbieter für diesen Adapter ab. (Geerbt von BotFrameworkAdapter) |
| HttpClient |
Er bekommt die individuelle Anpassung HttpClient für diesen Adapter, wenn angegeben. (Geerbt von BotFrameworkAdapter) |
| Logger |
Er bekommt den Logger für diesen Adapter. (Geerbt von BotFrameworkAdapter) |
| 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) |
| RequestHandlers |
Erhält oder setzt die Anfrage-Handler für diesen Adapter. (Geerbt von BotFrameworkHttpAdapterBase) |
Methoden
| Name | Beschreibung |
|---|---|
| BuildCredentialsAsync(String, String) |
Logik, um ein AppCredentials Objekt zu erstellen, das verwendet wird, um Token für diesen HttpClient zu erfassen. (Geerbt von BotFrameworkAdapter) |
| CanProcessOutgoingActivity(Activity) |
Bewertet, ob die Verarbeitung einer ausgehenden Aktivität möglich ist. (Geerbt von BotFrameworkHttpAdapterBase) |
| ConnectNamedPipeAsync(String, IBot, String) |
Erstellt einen neuen StreamingRequestHandler, der auf die angegebene Named Pipe hört und Anfragen an diesen Adapter weiterleitet. (Geerbt von BotFrameworkHttpAdapterBase) |
| 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. (Geerbt von BotFrameworkAdapter) |
| ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken) |
Sendet eine proaktive Nachricht vom Bot an eine Unterhaltung. (Geerbt von BotFrameworkAdapter) |
| 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. (Geerbt von BotFrameworkAdapter) |
| CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken) |
Erstellt eine Unterhaltung im angegebenen Kanal. (Geerbt von BotFrameworkAdapter) |
| CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken) |
Veraltet.
Erstellt eine Unterhaltung im angegebenen Kanal. Overload erhält eine ConversationReference, einschließlich des Tenants. (Geerbt von BotFrameworkAdapter) |
| CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken) |
Erstellt eine Unterhaltung im angegebenen Kanal. (Geerbt von BotFrameworkAdapter) |
| CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken) |
Veraltet.
Erstellt eine Unterhaltung im angegebenen Kanal. Overload erhält eine ConversationReference, einschließlich des Tenants. (Geerbt von BotFrameworkAdapter) |
| CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken) |
Erstellt eine Unterhaltung im angegebenen Kanal. (Geerbt von BotAdapter) |
| CreateOAuthApiClientAsync(ITurnContext, AppCredentials) |
Erstellt einen OAuth-Client für den Bot mit den Zugangsdaten. (Geerbt von BotFrameworkAdapter) |
| CreateOAuthApiClientAsync(ITurnContext) |
Erstellt einen OAuth-Client für den Bot. (Geerbt von BotFrameworkAdapter) |
| DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken) |
Löscht eine vorhandene Aktivität in der Unterhaltung. (Geerbt von BotFrameworkAdapter) |
| DeleteConversationMemberAsync(ITurnContext, String, CancellationToken) |
Entferne ein Mitglied aus der aktuellen Diskussion. (Geerbt von BotFrameworkAdapter) |
| Dispose() |
Eine Bot Builder Adapter-Implementierung, die zur Verarbeitung von HTTP-Anfragen des Bot-Frameworks verwendet wird. (Geerbt von BotFrameworkHttpAdapterBase) |
| Dispose(Boolean) |
Verfügt über Ressourcen der StreamingRequestHandler. (Geerbt von BotFrameworkHttpAdapterBase) |
| ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken) |
Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden. (Geerbt von BotFrameworkAdapter) |
| ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken) |
Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden. (Geerbt von BotFrameworkAdapter) |
| 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. (Geerbt von BotFrameworkAdapter) |
| GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken) |
Ruft Azure Active Directory-Token für bestimmte Ressourcen auf einer konfigurierten Verbindung ab, mithilfe der AppCredentials des Bots. (Geerbt von BotFrameworkAdapter) |
| GetActivityMembersAsync(ITurnContext, String, CancellationToken) |
Listet die Mitglieder einer bestimmten Aktivität auf. (Geerbt von BotFrameworkAdapter) |
| GetConversationMembersAsync(ITurnContext, CancellationToken) |
Listet die Mitglieder der aktuellen Unterhaltung auf. (Geerbt von BotFrameworkAdapter) |
| GetConversationsAsync(ITurnContext, String, CancellationToken) |
Listet die Unterhaltungen auf, an denen dieser Bot für einen bestimmten Kanalserver teilgenommen hat. Der Kanalserver liefert Ergebnisse in Seiten, und jede Seite enthält eine |
| GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken) |
Listet die Unterhaltungen auf, an denen dieser Bot für einen bestimmten Kanalserver teilgenommen hat. Der Kanalserver liefert Ergebnisse in Seiten, und jede Seite enthält eine |
| 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. (Geerbt von BotFrameworkAdapter) |
| 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. (Geerbt von BotFrameworkAdapter) |
| 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. (Geerbt von BotFrameworkAdapter) |
| 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. (Geerbt von BotFrameworkAdapter) |
| 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. (Geerbt von BotFrameworkAdapter) |
| GetSignInResourceAsync(ITurnContext, String, CancellationToken) |
Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden. (Geerbt von BotFrameworkAdapter) |
| 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. (Geerbt von BotFrameworkAdapter) |
| GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer mithilfe von angepassten AppCredentials ab. (Geerbt von BotFrameworkAdapter) |
| GetTokenStatusAsync(ITurnContext, String, String, CancellationToken) |
Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer mithilfe der AppCredentials des Bots ab. (Geerbt von BotFrameworkAdapter) |
| GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Versucht, das Token für einen Benutzer abzurufen, der sich in einem Anmeldefluss befindet, mithilfe von angepassten AppCredentials. (Geerbt von BotFrameworkAdapter) |
| GetUserTokenAsync(ITurnContext, String, String, CancellationToken) |
Versucht, das Token für einen Benutzer abzurufen, der sich in einem Login-Flow befindet, mithilfe der AppCredentials des Bots. (Geerbt von BotFrameworkAdapter) |
| ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken) |
Erstellt einen Turnkontext und führt die Middlewarepipeline für eine eingehende Aktivität aus. (Geerbt von BotFrameworkAdapter) |
| ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken) |
Erstellt einen Turnkontext und führt die Middlewarepipeline für eine eingehende Aktivität aus. (Geerbt von BotFrameworkAdapter) |
| ProcessAsync(HttpRequestMessage, HttpResponseMessage, IBot, CancellationToken) |
Diese Methode kann innerhalb einer POST-Methode in jeder Controller-Implementierung aufgerufen werden. |
| ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken) |
Schickt eine ausgehende Aktivität. (Geerbt von BotFrameworkHttpAdapterBase) |
| ProcessStreamingActivityAsync(Activity, BotCallbackHandler, CancellationToken) |
Primäre Adaptermethode für die Verarbeitung von Aktivitäten, die vom Streaming-Kanal gesendet werden. Erstellt einen Turnkontext und führt die Middlewarepipeline für eine eingehende Aktivität aus. Fügt ArgumentNullException Nullargumente hinzu. (Geerbt von BotFrameworkHttpAdapterBase) |
| 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. (Geerbt von BotFrameworkAdapter) |
| SendStreamingActivityAsync(Activity, CancellationToken) |
Schickt eine Aktivität. (Geerbt von BotFrameworkHttpAdapterBase) |
| SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Signiert den Benutzer mit dem Tokenserver mit angepassten AppCredentials. (Geerbt von BotFrameworkAdapter) |
| SignOutUserAsync(ITurnContext, String, String, CancellationToken) |
Meldet sich beim Token-Server über die AppCredentials des Bots ab. (Geerbt von BotFrameworkAdapter) |
| UpdateActivityAsync(ITurnContext, Activity, CancellationToken) |
Ersetzt eine vorhandene Aktivität in der Unterhaltung. (Geerbt von BotFrameworkAdapter) |
| Use(IMiddleware) |
Fügt Middleware zur Pipeline des Adapters hinzu. (Geerbt von BotFrameworkAdapter) |
Explizite Schnittstellenimplementierungen
| Name | Beschreibung |
|---|---|
| IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken) |
Eine Bot Builder Adapter-Implementierung, die zur Verarbeitung von HTTP-Anfragen des Bot-Frameworks verwendet wird. (Geerbt von BotFrameworkAdapter) |
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 Turnkontext am Anfang jeder Drehung. |
| 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 Turnkontext am Anfang jeder Drehung. |