BotFrameworkHttpAdapter Klass
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
En Bot Builder Adapter-implementation som används för att hantera HTTP-förfrågningar från botramverket.
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- Arv
- Implementeringar
Konstruktorer
| Name | Description |
|---|---|
| BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, HttpClient, ILogger<BotFrameworkHttpAdapter>) |
Initierar en ny instans av BotFrameworkHttpAdapter klassen. |
| BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, ILogger<BotFrameworkHttpAdapter>) |
Initierar en ny instans av BotFrameworkHttpAdapter klassen. |
Fält
| Name | Description |
|---|---|
| BotIdentityKey |
Strängvärdet för botens identitetsnyckel. (Ärvd från BotAdapter) |
| InvokeResponseKey |
Nyckelvärdet för varje InvokeResponseActivity som skulle finnas på TurnState. (Ärvd från BotAdapter) |
| OAuthScopeKey |
Strängvärdet för OAuth-scope-nyckeln. (Ärvd från BotAdapter) |
Egenskaper
| Name | Description |
|---|---|
| AppCredentialMap |
Hämtar applikationskartan för AppCredentials denna adapter. (Ärvd från BotFrameworkAdapter) |
| ChannelProvider |
Får kanalleverantören för denna adapter. (Ärvd från BotFrameworkAdapter) |
| ClaimsIdentity |
Får eller ställer in skadeidentiteten för denna adapter. (Ärvd från BotFrameworkHttpAdapterBase) |
| ConnectedBot |
Får eller ställer in boten kopplad till denna adapter. (Ärvd från BotFrameworkHttpAdapterBase) |
| CredentialProvider |
Får fram inloggningsgivaren för denna adapter. (Ärvd från BotFrameworkAdapter) |
| HttpClient |
Får specialanpassningen HttpClient för denna adapter om det specificeras. (Ärvd från BotFrameworkAdapter) |
| Logger |
Får loggern till denna adapter. (Ärvd från BotFrameworkAdapter) |
| MiddlewareSet |
Får samlingen av middleware i adapterns pipeline. (Ärvd från BotAdapter) |
| OnTurnError |
Hämtar eller sätter en felhanterare som kan fånga upp undantag i mellanvaran eller applikationen. (Ärvd från BotAdapter) |
| RequestHandlers |
Hämtar eller ställer in förfrågningshanterare för denna adapter. (Ärvd från BotFrameworkHttpAdapterBase) |
Metoder
| Name | Description |
|---|---|
| BuildCredentialsAsync(String, String) |
Logik för att bygga ett AppCredentials objekt som ska användas för att hämta tokens till denna HttpClient. (Ärvd från BotFrameworkAdapter) |
| CanProcessOutgoingActivity(Activity) |
Utvärderar om det är möjligt att hantera en utgående aktivitet. (Ärvd från BotFrameworkHttpAdapterBase) |
| ConnectNamedPipeAsync(String, IBot, String) |
Skapar en ny StreamingRequestHandler för att lyssna på den angivna namngivna pipan och skicka förfrågningar till denna adapter. (Ärvd från BotFrameworkHttpAdapterBase) |
| ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken) |
Skickar ett proaktivt meddelande till en konversation. (Ärvd från BotAdapter) |
| ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken) |
Skickar ett proaktivt meddelande till en konversation. (Ärvd från BotAdapter) |
| ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken) |
Skickar ett proaktivt meddelande från boten till en konversation. (Ärvd från BotFrameworkAdapter) |
| ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken) |
Skickar ett proaktivt meddelande från boten till en konversation. (Ärvd från BotFrameworkAdapter) |
| ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken) |
Skickar ett proaktivt meddelande till en konversation. (Ärvd från BotAdapter) |
| ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken) |
Skickar ett proaktivt meddelande från boten till en konversation. (Ärvd från BotFrameworkAdapter) |
| CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken) |
Skapar en konversation på den angivna kanalen. (Ärvd från BotFrameworkAdapter) |
| CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken) |
Föråldrad.
Skapar en konversation på den angivna kanalen. Overload tar emot en ConversationReference inklusive hyresgästen. (Ärvd från BotFrameworkAdapter) |
| CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken) |
Skapar en konversation på den angivna kanalen. (Ärvd från BotFrameworkAdapter) |
| CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken) |
Föråldrad.
Skapar en konversation på den angivna kanalen. Overload tar emot en ConversationReference inklusive hyresgästen. (Ärvd från BotFrameworkAdapter) |
| CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken) |
Skapar en konversation på den angivna kanalen. (Ärvd från BotAdapter) |
| CreateOAuthApiClientAsync(ITurnContext, AppCredentials) |
Skapar en OAuth-klient för boten med inloggningsuppgifterna. (Ärvd från BotFrameworkAdapter) |
| CreateOAuthApiClientAsync(ITurnContext) |
Skapar en OAuth-klient för boten. (Ärvd från BotFrameworkAdapter) |
| DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken) |
Tar bort en befintlig aktivitet i konversationen. (Ärvd från BotFrameworkAdapter) |
| DeleteConversationMemberAsync(ITurnContext, String, CancellationToken) |
Tar bort en medlem från den aktuella konversationen. (Ärvd från BotFrameworkAdapter) |
| Dispose() |
En Bot Builder Adapter-implementation som används för att hantera HTTP-förfrågningar från botramverket. (Ärvd från BotFrameworkHttpAdapterBase) |
| Dispose(Boolean) |
Disponerar resurser från StreamingRequestHandler. (Ärvd från BotFrameworkHttpAdapterBase) |
| ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken) |
Utför en tokenutbytesåtgärd, till exempel för enkel inloggning. (Ärvd från BotFrameworkAdapter) |
| ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken) |
Utför en tokenutbytesåtgärd, till exempel för enkel inloggning. (Ärvd från BotFrameworkAdapter) |
| GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken) |
Hämtar Azure Active Directory-tokens för specifika resurser på en konfigurerad anslutning, med hjälp av anpassade AppCredentials. (Ärvd från BotFrameworkAdapter) |
| GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken) |
Hämtar Azure Active Directory-tokens för specifika resurser på en konfigurerad anslutning med hjälp av botens AppCredentials. (Ärvd från BotFrameworkAdapter) |
| GetActivityMembersAsync(ITurnContext, String, CancellationToken) |
Visar en lista över medlemmar i en viss aktivitet. (Ärvd från BotFrameworkAdapter) |
| GetConversationMembersAsync(ITurnContext, CancellationToken) |
Listar medlemmarna i den aktuella konversationen. (Ärvd från BotFrameworkAdapter) |
| GetConversationsAsync(ITurnContext, String, CancellationToken) |
Visar en lista över konversationer där den här roboten har deltagit för en viss kanalserver. Kanalservern returnerar resultat i sidor och varje sida innehåller en |
| GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken) |
Visar en lista över konversationer där den här roboten har deltagit för en viss kanalserver. Kanalservern returnerar resultat i sidor och varje sida innehåller en |
| GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken) |
Få den råa inloggningslänken att skickas till användaren för inloggning för ett anslutningsnamn, med anpassade AppCredentials. (Ärvd från BotFrameworkAdapter) |
| GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken) |
Få den råa inloggningslänken att skickas till användaren för inloggning för ett anslutningsnamn, med anpassade AppCredentials. (Ärvd från BotFrameworkAdapter) |
| GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken) |
Få den råa inloggningslänken att skickas till användaren för inloggning för ett anslutningsnamn, med botens AppCredentials. (Ärvd från BotFrameworkAdapter) |
| GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken) |
Få den råa inloggningslänken att skickas till användaren för inloggning för ett anslutningsnamn, med botens AppCredentials. (Ärvd från BotFrameworkAdapter) |
| GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken) |
Hämta länken för råsignin som ska skickas till användaren för inloggning för ett anslutningsnamn. (Ärvd från BotFrameworkAdapter) |
| GetSignInResourceAsync(ITurnContext, String, CancellationToken) |
Hämta länken för råsignin som ska skickas till användaren för inloggning för ett anslutningsnamn. (Ärvd från BotFrameworkAdapter) |
| GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken) |
Hämta länken för råsignin som ska skickas till användaren för inloggning för ett anslutningsnamn. (Ärvd från BotFrameworkAdapter) |
| GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Hämtar tokenstatus för varje konfigurerad anslutning för den aktuella användaren, med hjälp av anpassade AppCredentials. (Ärvd från BotFrameworkAdapter) |
| GetTokenStatusAsync(ITurnContext, String, String, CancellationToken) |
Hämtar tokenstatusen för varje konfigurerad anslutning för den aktuella användaren, med hjälp av botens AppCredentials. (Ärvd från BotFrameworkAdapter) |
| GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Försöker hämta token för en användare som är i ett inloggningsflöde, med hjälp av anpassade AppCredentials. (Ärvd från BotFrameworkAdapter) |
| GetUserTokenAsync(ITurnContext, String, String, CancellationToken) |
Försöker hämta token för en användare som befinner sig i ett inloggningsflöde, med hjälp av botens AppCredentials. (Ärvd från BotFrameworkAdapter) |
| ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken) |
Skapar en turkontext och kör pipelinen för mellanprogram för en inkommande aktivitet. (Ärvd från BotFrameworkAdapter) |
| ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken) |
Skapar en turkontext och kör pipelinen för mellanprogram för en inkommande aktivitet. (Ärvd från BotFrameworkAdapter) |
| ProcessAsync(HttpRequestMessage, HttpResponseMessage, IBot, CancellationToken) |
Denna metod kan anropas inifrån en POST-metod på vilken Controller-implementation som helst. |
| ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken) |
Skickar en utgående aktivitet. (Ärvd från BotFrameworkHttpAdapterBase) |
| ProcessStreamingActivityAsync(Activity, BotCallbackHandler, CancellationToken) |
Primär adaptermetod för bearbetningsaktiviteter som skickas från strömningskanalen. Skapar en turkontext och kör pipelinen för mellanprogram för en inkommande aktivitet. Lägger ArgumentNullException till nullargument. (Ärvd från BotFrameworkHttpAdapterBase) |
| RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken) |
Startar aktivitetsbearbetning för den aktuella botturen. (Ärvd från BotAdapter) |
| SendActivitiesAsync(ITurnContext, Activity[], CancellationToken) |
Skickar aktiviteter till samtalet. (Ärvd från BotFrameworkAdapter) |
| SendStreamingActivityAsync(Activity, CancellationToken) |
Skickar en aktivitet. (Ärvd från BotFrameworkHttpAdapterBase) |
| SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Loggar ut användaren via tokenservern med anpassade AppCredentials. (Ärvd från BotFrameworkAdapter) |
| SignOutUserAsync(ITurnContext, String, String, CancellationToken) |
Loggar ut användaren med tokenservern med botens AppCredentials. (Ärvd från BotFrameworkAdapter) |
| UpdateActivityAsync(ITurnContext, Activity, CancellationToken) |
Ersätter en befintlig aktivitet i samtalet. (Ärvd från BotFrameworkAdapter) |
| Use(IMiddleware) |
Lägger till middleware i adapterns pipeline. (Ärvd från BotFrameworkAdapter) |
Explicita gränssnittsimplementeringar
| Name | Description |
|---|---|
| IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken) |
En Bot Builder Adapter-implementation som används för att hantera HTTP-förfrågningar från botramverket. (Ärvd från BotFrameworkAdapter) |
Tilläggsmetoder
| Name | Description |
|---|---|
| UseBotState(BotAdapter, BotState[]) |
Lägger till middleware i adaptern för att registrera ett eller flera BotState objekt i turn-kontexten. Mellanvaran registrerar tillståndsobjekten i turkontexten i början av varje tur. |
| UseState(BotAdapter, UserState, ConversationState, Boolean) |
Föråldrad.
Registrerar användar- och konversationstillståndsobjekt med adaptern. Dessa objekt kommer att vara tillgängliga via tur-kontextens TurnState.Get<T>() metod. |
| UseStorage(BotAdapter, IStorage) |
Lägger till middleware i adaptern för att registrera ett IStorage objekt i vändningskontexten. Mellanvaran registrerar tillståndsobjekten i turkontexten i början av varje tur. |