BotFrameworkAdapter Klass

Referens

Definition

Namnområde:: Microsoft.Bot.Builder

Sammansättning:: Microsoft.Bot.Builder.dll

Paket:: Microsoft.Bot.Builder v4.22.7

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.

Ett robotkort som kan ansluta en robot till en tjänstslutpunkt.

public class BotFrameworkAdapter : Microsoft.Bot.Builder.BotAdapter, Microsoft.Bot.Builder.IExtendedUserTokenProvider, Microsoft.Bot.Builder.Integration.IAdapterIntegration, Microsoft.Bot.Builder.OAuth.IConnectorClientBuilder

type BotFrameworkAdapter = class
    inherit BotAdapter
    interface IAdapterIntegration
    interface IExtendedUserTokenProvider
    interface IUserTokenProvider
    interface IConnectorClientBuilder

Public Class BotFrameworkAdapter
Inherits BotAdapter
Implements IAdapterIntegration, IConnectorClientBuilder, IExtendedUserTokenProvider

Arv: Object

BotAdapter
BotFrameworkAdapter

Härledda: Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase

Implementeringar: IExtendedUserTokenProvider IAdapterIntegration IUserTokenProvider IConnectorClientBuilder

Kommentarer

BotFrameworkAdapter stöds fortfarande, men det rekommenderade kortet är "CloudAdapter". Robotkortet kapslar in autentiseringsprocesser och skickar aktiviteter till och tar emot aktiviteter från Bot Connector-tjänsten. När roboten tar emot en aktivitet skapar adaptern ett kontextobjekt, skickar det till robotens programlogik och skickar svar tillbaka till användarens kanal.

Använd Use(IMiddleware) för att lägga till IMiddleware objekt i adapterns mellanprogramsamling. Adaptern bearbetar och dirigerar inkommande aktiviteter via robotens mellanprogramspipeline till robotens logik och backar sedan ut igen. När varje aktivitet flödar in och ut ur roboten kan varje mellanprogram inspektera eller agera på aktiviteten, både före och efter att robotlogik körs.

Konstruktorer

BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Initierar en ny instans av klassen BotFrameworkAdapter med hjälp av en provider för autentiseringsuppgifter.
BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Initierar en ny instans av klassen BotFrameworkAdapter med hjälp av en provider för autentiseringsuppgifter.
BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Initierar en ny instans av klassen BotFrameworkAdapter med hjälp av en provider för autentiseringsuppgifter.

Fält

BotIdentityKey	Strängvärdet för robotens identitetsnyckel. (Ärvd från BotAdapter)
InvokeResponseKey	Nyckelvärdet för alla InvokeResponseActivity som skulle finnas på TurnState. (Ärvd från BotAdapter)
OAuthScopeKey	Strängvärdet för OAuth-omfångsnyckeln. (Ärvd från BotAdapter)

Egenskaper

AppCredentialMap	Hämtar kartan över program till AppCredentials för det här kortet.
ChannelProvider	Hämtar kanalprovidern för det här kortet.
CredentialProvider	Hämtar providern för autentiseringsuppgifter för det här kortet.
HttpClient	Hämtar anpassade HttpClient för det här kortet om det anges.
Logger	Hämtar loggaren för det här kortet.
MiddlewareSet	Hämtar samlingen mellanprogram i adapterns pipeline. (Ärvd från BotAdapter)
OnTurnError	Hämtar eller anger en felhanterare som kan fånga undantag i mellanprogrammet eller programmet. (Ärvd från BotAdapter)

Metoder

BuildCredentialsAsync(String, String)	Logik för att skapa ett AppCredentials objekt som ska användas för att hämta token för denna HttpClient.
CanProcessOutgoingActivity(Activity)	Möjlighet för underklasser att välja att bearbeta en utgående aktivitet.
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 roboten till en konversation.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Skickar ett proaktivt meddelande från roboten till en konversation.
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 roboten till en konversation.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Skapar en konversation på den angivna kanalen.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Föråldrad. Skapar en konversation på den angivna kanalen. Överlagring tar emot en ConversationReference inklusive klientorganisationen.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Skapar en konversation på den angivna kanalen.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Föråldrad. Skapar en konversation på den angivna kanalen. Överlagring tar emot en ConversationReference inklusive klientorganisationen.
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Skapar en konversation på den angivna kanalen. (Ärvd från BotAdapter)
CreateOAuthApiClientAsync(ITurnContext)	Skapar en OAuth-klient för roboten.
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	Skapar en OAuth-klient för roboten med autentiseringsuppgifterna.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Tar bort en befintlig aktivitet i konversationen.
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	Tar bort en medlem från den aktuella konversationen.
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	Utför en tokenutbytesåtgärd, till exempel för enkel inloggning.
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	Utför en tokenutbytesåtgärd, till exempel för enkel inloggning.
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)	Hämtar Azure Active Directory-token för specifika resurser på en konfigurerad anslutning med hjälp av anpassade AppCredentials.
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	Hämtar Azure Active Directory-token för specifika resurser på en konfigurerad anslutning med hjälp av robotens AppCredentials.
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	Visar en lista över medlemmar i en viss aktivitet.
GetConversationMembersAsync(ITurnContext, CancellationToken)	Visar en lista över medlemmar i den aktuella konversationen.
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 på sidor och varje sida innehåller en `continuationToken` som kan användas för att hämta nästa sida med resultat från servern.
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 på sidor och varje sida innehåller en `continuationToken` som kan användas för att hämta nästa sida med resultat från servern.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	Hämta länken för råsignin som ska skickas till användaren för inloggning för ett anslutningsnamn med hjälp av anpassade AppCredentials.
GetOauthSignInLinkAsync(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 med hjälp av anpassade AppCredentials.
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	Hämta länken för rå inloggning som ska skickas till användaren för inloggning för ett anslutningsnamn med hjälp av robotens AppCredentials.
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	Hämta länken för rå inloggning som ska skickas till användaren för inloggning för ett anslutningsnamn med hjälp av robotens AppCredentials.
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.
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.
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.
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Hämtar tokenstatusen för varje konfigurerad anslutning för den angivna användaren med hjälp av anpassade AppCredentials.
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	Hämtar tokenstatusen för varje konfigurerad anslutning för den angivna användaren med hjälp av robotens AppCredentials.
GetUserTokenAsync(ITurnContext, AppCredentials, 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 anpassade AppCredentials.
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 robotens AppCredentials.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Skapar en turkontext och kör pipelinen för mellanprogram för en inkommande aktivitet.
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	Skapar en turkontext och kör pipelinen för mellanprogram för en inkommande aktivitet.
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Anpassad logik för att skicka en utgående aktivitet. Underklasser kan åsidosätta den här metoden tillsammans med CanProcessOutgoingActivity för att ha anpassad logik för att bearbeta den utgående aktiviteten.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Startar aktivitetsbearbetningen för den aktuella robotsvängen. (Ärvd från BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	Skickar aktiviteter till konversationen.
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Loggar ut användaren med tokenservern med anpassade AppCredentials.
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Loggar ut användaren med tokenservern med hjälp av robotens AppCredentials.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Ersätter en befintlig aktivitet i konversationen.
Use(IMiddleware)	Lägger till mellanprogram i adapterns pipeline.

Explicita gränssnittsimplementeringar

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

Ett robotkort som kan ansluta en robot till en tjänstslutpunkt.

Tilläggsmetoder

UseBotState(BotAdapter, BotState[])	Lägger till mellanprogram i adaptern för att registrera ett eller flera BotState objekt i turn-kontexten. Mellanprogrammet 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 turkontextens TurnState.Get<T>() metod.
UseStorage(BotAdapter, IStorage)	Lägger till mellanprogram i adaptern för att registrera ett IStorage objekt i turn-kontexten. Mellanprogrammet registrerar tillståndsobjekten i turkontexten i början av varje tur.

Gäller för

Dela via