BotFrameworkAdapter Classe

Riferimento

Definizione

Spazio dei nomi:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Pacchetto:: Microsoft.Bot.Builder v4.22.7

Importante

Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.

Adattatore bot in grado di connettere un bot a un endpoint di servizio.

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

Ereditarietà: Object

BotAdapter
BotFrameworkAdapter

Derivato: Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase

Implementazioni: IExtendedUserTokenProvider IAdapterIntegration IUserTokenProvider IConnectorClientBuilder

Commenti

BotFrameworkAdapter è ancora supportato, ma l'adattatore consigliato è "CloudAdapter". L'adapter bot incapsula i processi di autenticazione e invia attività a e riceve attività dal servizio Bot Connector. Quando il bot riceve un'attività, l'adapter crea un oggetto contesto, lo passa alla logica dell'applicazione del bot e invia le risposte al canale dell'utente.

Utilizzare Use(IMiddleware) per aggiungere oggetti IMiddleware alla raccolta middleware dell'adattatore. L'adapter elabora e indirizza le attività in ingresso tramite la pipeline del middleware del bot alla logica del bot e quindi torna indietro. Man mano che ogni attività scorre all'interno e all'esterno del bot, ogni parte del middleware può esaminare o agire sull'attività, sia prima che dopo l'esecuzione della logica del bot.

Costruttori

BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inizializza una nuova istanza della classe BotFrameworkAdapter utilizzando un provider di credenziali.
BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inizializza una nuova istanza della classe BotFrameworkAdapter utilizzando un provider di credenziali.
BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inizializza una nuova istanza della classe BotFrameworkAdapter utilizzando un provider di credenziali.

Campi

BotIdentityKey	Valore stringa per la chiave di identità del bot. (Ereditato da BotAdapter)
InvokeResponseKey	Valore della chiave per qualsiasi InvokeResponseActivity che si troverebbe su TurnState. (Ereditato da BotAdapter)
OAuthScopeKey	Valore stringa per la chiave dell'ambito OAuth. (Ereditato da BotAdapter)

Proprietà

AppCredentialMap	Ottiene la mappa delle applicazioni a AppCredentials per l'adapter.
ChannelProvider	Ottiene il provider di canali per questa scheda.
CredentialProvider	Ottiene il provider di credenziali per l'adapter.
HttpClient	Ottiene il HttpClient personalizzato per l'adattatore, se specificato.
Logger	Ottiene il logger per l'adapter.
MiddlewareSet	Ottiene la raccolta di middleware nella pipeline dell'adattatore. (Ereditato da BotAdapter)
OnTurnError	Ottiene o imposta un gestore errori che può intercettare le eccezioni nel middleware o nell'applicazione. (Ereditato da BotAdapter)

Metodi

BuildCredentialsAsync(String, String)	Logica per compilare un oggetto AppCredentials da usare per acquisire i token per questo HttpClient.
CanProcessOutgoingActivity(Activity)	Opportunità per le sottoclassi di acconsentire esplicitamente all'elaborazione di un'attività in uscita.
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Invia un messaggio proattivo a una conversazione. (Ereditato da BotAdapter)
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	Invia un messaggio proattivo a una conversazione. (Ereditato da BotAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	Invia un messaggio proattivo dal bot a una conversazione.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Invia un messaggio proattivo dal bot a una conversazione.
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	Invia un messaggio proattivo a una conversazione. (Ereditato da BotAdapter)
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	Invia un messaggio proattivo dal bot a una conversazione.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Crea una conversazione sul canale specificato.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Obsoleti. Crea una conversazione sul canale specificato. L'overload riceve conversationReference, incluso il tenant.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Crea una conversazione sul canale specificato.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Obsoleti. Crea una conversazione sul canale specificato. L'overload riceve conversationReference, incluso il tenant.
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Crea una conversazione sul canale specificato. (Ereditato da BotAdapter)
CreateOAuthApiClientAsync(ITurnContext)	Crea un client OAuth per il bot.
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	Crea un client OAuth per il bot con le credenziali.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Elimina un'attività esistente nella conversazione.
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	Rimuove un membro dalla conversazione corrente.
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	Esegue un'operazione di scambio di token, ad esempio per l'accesso Single Sign-On.
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	Esegue un'operazione di scambio di token, ad esempio per l'accesso Single Sign-On.
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)	Recupera i token di Azure Active Directory per determinate risorse in una connessione configurata usando appCredentials personalizzate.
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	Recupera i token di Azure Active Directory per determinate risorse in una connessione configurata usando le credenziali app del bot.
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	Elenca i membri di una determinata attività.
GetConversationMembersAsync(ITurnContext, CancellationToken)	Elenca i membri della conversazione corrente.
GetConversationsAsync(ITurnContext, String, CancellationToken)	Elenca le conversazioni in cui questo bot ha partecipato per un determinato server di canale. Il server di canale restituisce i risultati nelle pagine e ogni pagina includerà un `continuationToken` che può essere utilizzato per recuperare la pagina successiva dei risultati dal server.
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken)	Elenca le conversazioni in cui questo bot ha partecipato per un determinato server di canale. Il server di canale restituisce i risultati nelle pagine e ogni pagina includerà un `continuationToken` che può essere utilizzato per recuperare la pagina successiva dei risultati dal server.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione usando AppCredentials personalizzato.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione usando AppCredentials personalizzato.
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione, usando le credenziali app del bot.
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione, usando le credenziali app del bot.
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)	Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Recupera lo stato del token per ogni connessione configurata per l'utente specificato, usando AppCredentials personalizzato.
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	Recupera lo stato del token per ogni connessione configurata per l'utente specificato, usando le credenziali app del bot.
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Tenta di recuperare il token per un utente che si trova in un flusso di accesso usando AppCredentials personalizzato.
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	Tenta di recuperare il token per un utente che si trova in un flusso di accesso, usando le credenziali app del bot.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Crea un contesto di turno ed esegue la pipeline middleware per un'attività in ingresso.
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	Crea un contesto di turno ed esegue la pipeline middleware per un'attività in ingresso.
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Logica personalizzata per inviare un'attività in uscita. Le sottoclassi possono eseguire l'override di questo metodo insieme a CanProcessOutgoingActivity per avere una logica personalizzata per elaborare l'attività in uscita.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Avvia l'elaborazione delle attività per il turno corrente del bot. (Ereditato da BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	Invia attività alla conversazione.
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Disconnette l'utente con il server token usando AppCredentials personalizzato.
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Disconnette l'utente con il server token usando le credenziali app del bot.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Sostituisce un'attività esistente nella conversazione.
Use(IMiddleware)	Aggiunge middleware alla pipeline dell'adapter.

Implementazioni dell'interfaccia esplicita

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

Adattatore bot in grado di connettere un bot a un endpoint di servizio.

Metodi di estensione

UseBotState(BotAdapter, BotState[])	Aggiunge middleware all'adattatore per registrare uno o più oggetti BotState nel contesto di turno. Il middleware registra gli oggetti di stato nel contesto di turno all'inizio di ogni turno.
UseState(BotAdapter, UserState, ConversationState, Boolean)	Obsoleti. Registra gli oggetti stato utente e conversazione con l'adattatore. Questi oggetti saranno disponibili tramite il contesto di turno TurnState.Get<T>() metodo.
UseStorage(BotAdapter, IStorage)	Aggiunge middleware all'adattatore per registrare un oggetto IStorage nel contesto di turno. Il middleware registra gli oggetti di stato nel contesto di turno all'inizio di ogni turno.

Si applica a

Condividi tramite