CloudAdapter 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 adapter som implementerar Bot Framework Protocol och kan hostas i olika molnmiljöer, både offentliga och privata.
public class CloudAdapter : Microsoft.Bot.Builder.CloudAdapterBase, Microsoft.Bot.Builder.Integration.AspNet.Core.IBotFrameworkHttpAdapter
type CloudAdapter = class
inherit CloudAdapterBase
interface IBotFrameworkHttpAdapter
Public Class CloudAdapter
Inherits CloudAdapterBase
Implements IBotFrameworkHttpAdapter
- Arv
- Implementeringar
Konstruktorer
| Name | Description |
|---|---|
| CloudAdapter() |
Initierar en ny instans av CloudAdapter klassen. (Publikt moln. Ingen auktorisation. För testning.) |
| CloudAdapter(BotFrameworkAuthentication, ILogger) |
Initierar en ny instans av CloudAdapter klassen. |
| CloudAdapter(IConfiguration, IHttpClientFactory, ILogger) |
Initierar en ny instans av CloudAdapter 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 |
|---|---|
| BotFrameworkAuthentication |
Får instansen BotFrameworkAuthentication för denna adapter. (Ärvd från CloudAdapterBase) |
| Logger |
Får en ILogger att använda inom denna adapter och dess underklasser. (Ärvd från CloudAdapterBase) |
| 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) |
Metoder
| Name | Description |
|---|---|
| ConnectNamedPipeAsync(String, IBot, String, String, String) |
Används för att koppla adaptern till ett namngivet rör. |
| ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken) |
Skickar ett proaktivt meddelande till en konversation. (Ärvd från CloudAdapterBase) |
| ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken) |
Skickar ett proaktivt meddelande till en konversation. (Ärvd från CloudAdapterBase) |
| ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken) |
Skickar ett proaktivt meddelande från boten till en konversation. (Ärvd från CloudAdapterBase) |
| ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken) |
Skickar ett proaktivt meddelande från boten till en konversation. (Ärvd från CloudAdapterBase) |
| ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken) |
Skickar ett proaktivt meddelande till en konversation. (Ärvd från CloudAdapterBase) |
| ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken) |
Skickar ett proaktivt meddelande från boten till en konversation. (Ärvd från CloudAdapterBase) |
| CreateClaimsIdentity(String) |
Detta är en hjälpare för att skapa ClaimsIdentity-strukturen från en appId som ska läggas till i TurnContext. Den är avsedd för användning i proaktiva och namngivna rörscenarier. (Ärvd från CloudAdapterBase) |
| CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken) |
Skapar en konversation på den angivna kanalen. (Ärvd från CloudAdapterBase) |
| CreateWebSocketConnection(WebSocket, ILogger) |
Skapar en StreamingConnection som använder websockets. |
| DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken) |
När den åsidosätts i en härledd klass raderas en befintlig aktivitet i konversationen. (Ärvd från CloudAdapterBase) |
| GetStreamingConnectorFactory(Activity) |
Får rätt streaming-anslutningsfabrik som bearbetar den givna aktiviteten. |
| ProcessActivityAsync(AuthenticateRequestResult, Activity, BotCallbackHandler, CancellationToken) |
Implementeringen för att bearbeta en aktivitet skickad till denna bot. (Ärvd från CloudAdapterBase) |
| ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken) |
Skapar en turn-context och kör middleware-pipelinen för en inkommande BETRODD aktivitet. (Ärvd från BotAdapter) |
| ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken) |
Implementeringen för att bearbeta en aktivitet skickad till denna bot. (Ärvd från CloudAdapterBase) |
| ProcessAsync(HttpRequest, HttpResponse, IBot, CancellationToken) |
Behandlar den inkommande HTTP-förfrågan med boten vilket resulterar i det utgående HTTP-svaret, denna metod kan anropas direkt från en Controller. Om HTTP-metoden är en POST kommer brödtexten att innehålla Activity to-process. |
| ProcessProactiveAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken) |
Implementeringen för att fortsätta samtalet. (Ärvd från CloudAdapterBase) |
| RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken) |
Startar aktivitetsbearbetning för den aktuella botturen. (Ärvd från BotAdapter) |
| SendActivitiesAsync(ITurnContext, Activity[], CancellationToken) |
När den överskrids i en härledd klass skickar den aktiviteter till samtalet. (Ärvd från CloudAdapterBase) |
| UpdateActivityAsync(ITurnContext, Activity, CancellationToken) |
När den överskrids i en härledd klass, ersätter den en befintlig aktivitet i samtalet. (Ärvd från CloudAdapterBase) |
| Use(IMiddleware) |
Lägger till middleware i adapterns pipeline. (Ärvd från BotAdapter) |
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. |