BotFrameworkHttpAdapter Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Implementacja Bot Builder Adapter służąca do obsługi zażądań HTTP w ramach botów w ramach Framework.
public class BotFrameworkHttpAdapter : Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase, Microsoft.Bot.Builder.Integration.AspNet.WebApi.IBotFrameworkHttpAdaptertype BotFrameworkHttpAdapter = class
inherit BotFrameworkHttpAdapterBase
interface IBotFrameworkHttpAdapterPublic Class BotFrameworkHttpAdapter
Inherits BotFrameworkHttpAdapterBase
Implements IBotFrameworkHttpAdapter- Dziedziczenie
- Implementuje
Konstruktory
| Nazwa | Opis |
|---|---|
| BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, HttpClient, ILogger<BotFrameworkHttpAdapter>) |
Inicjuje nowe wystąpienie klasy BotFrameworkHttpAdapter. |
| BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, ILogger<BotFrameworkHttpAdapter>) |
Inicjuje nowe wystąpienie klasy BotFrameworkHttpAdapter. |
Pola
| Nazwa | Opis |
|---|---|
| BotIdentityKey |
Wartość ciągu dla klucza tożsamości bota. (Odziedziczone po BotAdapter) |
| InvokeResponseKey |
Wartość kluczowa dla każdej aktywności InvokeResponse, która znajduje się w TurnState. (Odziedziczone po BotAdapter) |
| OAuthScopeKey |
Wartość ciągu dla klucza zakresu OAuth. (Odziedziczone po BotAdapter) |
Właściwości
| Nazwa | Opis |
|---|---|
| AppCredentialMap |
Otrzymuje mapę zastosowań AppCredentials dla tego adaptera. (Odziedziczone po BotFrameworkAdapter) |
| ChannelProvider |
Dostaje dostawcę kanału dla tego adaptera. (Odziedziczone po BotFrameworkAdapter) |
| ClaimsIdentity |
Pobiera lub ustawia tożsamość roszczeń dla tego adaptera. (Odziedziczone po BotFrameworkHttpAdapterBase) |
| ConnectedBot |
Pobiera lub ustawia bota podłączonego do tego adaptera. (Odziedziczone po BotFrameworkHttpAdapterBase) |
| CredentialProvider |
Dostaje dostawcę danych uwierzytelniających dla tego adaptera. (Odziedziczone po BotFrameworkAdapter) |
| HttpClient |
Dostaje customowy HttpClient adapter do tego adaptera, jeśli jest to zaznaczone. (Odziedziczone po BotFrameworkAdapter) |
| Logger |
Dostaje logger do tego adaptera. (Odziedziczone po BotFrameworkAdapter) |
| MiddlewareSet |
Pobiera kolekcję middleware z pipeline'u adaptera. (Odziedziczone po BotAdapter) |
| OnTurnError |
Pobiera lub ustawia obsługę błędów, która może wykrywać wyjątki w middleware lub aplikacji. (Odziedziczone po BotAdapter) |
| RequestHandlers |
Pobiera lub ustawia obsługę żądań dla tego adaptera. (Odziedziczone po BotFrameworkHttpAdapterBase) |
Metody
| Nazwa | Opis |
|---|---|
| BuildCredentialsAsync(String, String) |
Logika budowy obiektu AppCredentials do pozyskiwania tokenów dla tego HttpClienta. (Odziedziczone po BotFrameworkAdapter) |
| CanProcessOutgoingActivity(Activity) |
Ocenia, czy możliwe jest przetwarzanie wychodzącej aktywności. (Odziedziczone po BotFrameworkHttpAdapterBase) |
| ConnectNamedPipeAsync(String, IBot, String) |
Tworzy nowy StreamingRequestHandler do słuchania określonego Nazwanego Rury i przekazywania żądań do tego adaptera. (Odziedziczone po BotFrameworkHttpAdapterBase) |
| ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken) |
Wysyła proaktywną wiadomość do konwersacji. (Odziedziczone po BotAdapter) |
| ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken) |
Wysyła proaktywną wiadomość do konwersacji. (Odziedziczone po BotAdapter) |
| ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken) |
Wysyła proaktywną wiadomość od bota do rozmowy. (Odziedziczone po BotFrameworkAdapter) |
| ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken) |
Wysyła proaktywną wiadomość od bota do rozmowy. (Odziedziczone po BotFrameworkAdapter) |
| ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken) |
Wysyła proaktywną wiadomość do konwersacji. (Odziedziczone po BotAdapter) |
| ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken) |
Wysyła proaktywną wiadomość od bota do rozmowy. (Odziedziczone po BotFrameworkAdapter) |
| CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken) |
Tworzy rozmowę na określonym kanale. (Odziedziczone po BotFrameworkAdapter) |
| CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken) |
Przestarzałe.
Tworzy rozmowę na określonym kanale. Przeciążenie otrzymuje ConversationReference w tym najemcę. (Odziedziczone po BotFrameworkAdapter) |
| CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken) |
Tworzy rozmowę na określonym kanale. (Odziedziczone po BotFrameworkAdapter) |
| CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken) |
Przestarzałe.
Tworzy rozmowę na określonym kanale. Przeciążenie otrzymuje ConversationReference w tym najemcę. (Odziedziczone po BotFrameworkAdapter) |
| CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken) |
Tworzy rozmowę na określonym kanale. (Odziedziczone po BotAdapter) |
| CreateOAuthApiClientAsync(ITurnContext, AppCredentials) |
Tworzy klienta OAuth dla bota z danymi logowaniami. (Odziedziczone po BotFrameworkAdapter) |
| CreateOAuthApiClientAsync(ITurnContext) |
Tworzy klienta OAuth dla bota. (Odziedziczone po BotFrameworkAdapter) |
| DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken) |
Usuwa istniejącą aktywność w rozmowie. (Odziedziczone po BotFrameworkAdapter) |
| DeleteConversationMemberAsync(ITurnContext, String, CancellationToken) |
Usuwa członka z bieżącej rozmowy. (Odziedziczone po BotFrameworkAdapter) |
| Dispose() |
Implementacja Bot Builder Adapter służąca do obsługi zażądań HTTP w ramach botów w ramach Framework. (Odziedziczone po BotFrameworkHttpAdapterBase) |
| Dispose(Boolean) |
Dysponuje zasobami .StreamingRequestHandler (Odziedziczone po BotFrameworkHttpAdapterBase) |
| ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken) |
Wykonuje operację wymiany tokenów, taką jak na potrzeby logowania jednokrotnego. (Odziedziczone po BotFrameworkAdapter) |
| ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken) |
Wykonuje operację wymiany tokenów, taką jak na potrzeby logowania jednokrotnego. (Odziedziczone po BotFrameworkAdapter) |
| GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken) |
Pobiera tokeny Azure Active Directory dla konkretnych zasobów na skonfigurowanym połączeniu, używając spersonalizowanych AppCredentials. (Odziedziczone po BotFrameworkAdapter) |
| GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken) |
Pobiera tokeny Azure Active Directory dla konkretnych zasobów na skonfigurowanym połączeniu, używając AppCredentials bota. (Odziedziczone po BotFrameworkAdapter) |
| GetActivityMembersAsync(ITurnContext, String, CancellationToken) |
Wyświetla listę członków danego działania. (Odziedziczone po BotFrameworkAdapter) |
| GetConversationMembersAsync(ITurnContext, CancellationToken) |
Wymienia członków obecnej rozmowy. (Odziedziczone po BotFrameworkAdapter) |
| GetConversationsAsync(ITurnContext, String, CancellationToken) |
Wyświetla listę konwersacji, w których ten bot brał udział w danym serwerze kanału. Serwer kanałowy zwraca wyniki w formie stron, a każda strona zawiera , |
| GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken) |
Wyświetla listę konwersacji, w których ten bot brał udział w danym serwerze kanału. Serwer kanałowy zwraca wyniki w formie stron, a każda strona zawiera , |
| GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken) |
Pobierz surowy link logowania, który zostanie wysłany do użytkownika do logowania się pod nazwą połączenia, używając dostosowanych danych uwierzytelniających AppCredentials. (Odziedziczone po BotFrameworkAdapter) |
| GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken) |
Pobierz surowy link logowania, który zostanie wysłany do użytkownika do logowania się pod nazwą połączenia, używając dostosowanych danych uwierzytelniających AppCredentials. (Odziedziczone po BotFrameworkAdapter) |
| GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken) |
Pobierz surowy link logowania, który zostanie wysłany do użytkownika do logowania się pod nazwą połączenia, używając AppCredentials bota. (Odziedziczone po BotFrameworkAdapter) |
| GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken) |
Pobierz surowy link logowania, który zostanie wysłany do użytkownika do logowania się pod nazwą połączenia, używając AppCredentials bota. (Odziedziczone po BotFrameworkAdapter) |
| GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken) |
Pobierz link nieprzetworzonego logowania, który ma zostać wysłany do użytkownika na potrzeby logowania w celu uzyskania nazwy połączenia. (Odziedziczone po BotFrameworkAdapter) |
| GetSignInResourceAsync(ITurnContext, String, CancellationToken) |
Pobierz link nieprzetworzonego logowania, który ma zostać wysłany do użytkownika na potrzeby logowania w celu uzyskania nazwy połączenia. (Odziedziczone po BotFrameworkAdapter) |
| GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken) |
Pobierz link nieprzetworzonego logowania, który ma zostać wysłany do użytkownika na potrzeby logowania w celu uzyskania nazwy połączenia. (Odziedziczone po BotFrameworkAdapter) |
| GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Pobiera status tokena dla każdego skonfigurowanego połączenia dla danego użytkownika, używając spersonalizowanych AppCredentials. (Odziedziczone po BotFrameworkAdapter) |
| GetTokenStatusAsync(ITurnContext, String, String, CancellationToken) |
Pobiera status tokena dla każdego skonfigurowanego połączenia dla danego użytkownika, używając AppCredentials bota. (Odziedziczone po BotFrameworkAdapter) |
| GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Próbuje pobrać token dla użytkownika będącego w procesie logowania, używając spersonalizowanych danych uwierzytelniających App. (Odziedziczone po BotFrameworkAdapter) |
| GetUserTokenAsync(ITurnContext, String, String, CancellationToken) |
Próby pobrania tokena dla użytkownika będącego w procesie logowania, używając AppCredentials bota. (Odziedziczone po BotFrameworkAdapter) |
| ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken) |
Tworzy kontekst kolei i uruchamia potok oprogramowania pośredniczącego dla działania przychodzącego. (Odziedziczone po BotFrameworkAdapter) |
| ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken) |
Tworzy kontekst kolei i uruchamia potok oprogramowania pośredniczącego dla działania przychodzącego. (Odziedziczone po BotFrameworkAdapter) |
| ProcessAsync(HttpRequestMessage, HttpResponseMessage, IBot, CancellationToken) |
Metoda ta może być wywołana z wewnątrz metody POST w dowolnej implementacji kontrolera. |
| ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken) |
Wysyła wiadomość o wyjściu. (Odziedziczone po BotFrameworkHttpAdapterBase) |
| ProcessStreamingActivityAsync(Activity, BotCallbackHandler, CancellationToken) |
Podstawowa metoda adaptera do przetwarzania aktywności wysyłanych z kanału streamingowego. Tworzy kontekst kolei i uruchamia potok oprogramowania pośredniczącego dla działania przychodzącego. Dodaje ArgumentNullException argumenty nieważne. (Odziedziczone po BotFrameworkHttpAdapterBase) |
| RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken) |
Rozpoczyna przetwarzanie aktywności na bieżącą turę bota. (Odziedziczone po BotAdapter) |
| SendActivitiesAsync(ITurnContext, Activity[], CancellationToken) |
Wysyła aktywności do rozmowy. (Odziedziczone po BotFrameworkAdapter) |
| SendStreamingActivityAsync(Activity, CancellationToken) |
Wysyła aktywność. (Odziedziczone po BotFrameworkHttpAdapterBase) |
| SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Wylogowuje użytkownika za pomocą serwera tokenów, używając spersonalizowanych danych uwierzytelniających App. (Odziedziczone po BotFrameworkAdapter) |
| SignOutUserAsync(ITurnContext, String, String, CancellationToken) |
Wylogowuje użytkownika za pomocą serwera tokenów, używając AppCredentials bota. (Odziedziczone po BotFrameworkAdapter) |
| UpdateActivityAsync(ITurnContext, Activity, CancellationToken) |
Zastępuje istniejącą aktywność w rozmowie. (Odziedziczone po BotFrameworkAdapter) |
| Use(IMiddleware) |
Dodaje middleware do pipeline'u adaptera. (Odziedziczone po BotFrameworkAdapter) |
Jawne implementacje interfejsu
| Nazwa | Opis |
|---|---|
| IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken) |
Implementacja Bot Builder Adapter służąca do obsługi zażądań HTTP w ramach botów w ramach Framework. (Odziedziczone po BotFrameworkAdapter) |
Metody rozszerzania
| Nazwa | Opis |
|---|---|
| UseBotState(BotAdapter, BotState[]) |
Dodaje middleware do adaptera, aby rejestrować jeden lub więcej BotState obiektów w kontekście tury. Middleware rejestruje obiekty stanu w kontekście tury na początku każdej tury. |
| UseState(BotAdapter, UserState, ConversationState, Boolean) |
Przestarzałe.
Rejestruje obiekty stanu użytkownika i rozmowy za pomocą adaptera. Obiekty te będą dostępne za pomocą metody .Get<T>() w kontekście TurnStatetur. |
| UseStorage(BotAdapter, IStorage) |
Dodaje middleware do adaptera, aby rejestrować IStorage obiekt w kontekście tury. Middleware rejestruje obiekty stanu w kontekście tury na początku każdej tury. |