BotFrameworkAdapter Klas

Definitie

Naamruimte:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Pakket:: Microsoft.Bot.Builder v4.22.7

Belangrijk

Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.

Een botadapter die een bot kan verbinden met een service-eindpunt.

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

Overname: Object

BotAdapter
BotFrameworkAdapter

Afgeleid: Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase

Implementeringen: IExtendedUserTokenProvider IAdapterIntegration IUserTokenProvider IConnectorClientBuilder

Opmerkingen

BotFrameworkAdapter wordt nog steeds ondersteund, maar de aanbevolen adapter is CloudAdapter. De botadapter bevat verificatieprocessen en verzendt activiteiten naar en ontvangt activiteiten van de Bot Connector Service. Wanneer uw bot een activiteit ontvangt, maakt de adapter een contextobject, geeft deze door aan de toepassingslogica van uw bot en stuurt deze antwoorden terug naar het kanaal van de gebruiker.

Gebruik Use(IMiddleware) om objecten toe te voegen IMiddleware aan de middlewarecollectie van je adapter. De adapter verwerkt en stuurt binnenkomende activiteiten door middel van de bot-middlewarepijplijn naar de logica van uw bot en vervolgens weer terug. Wanneer elke activiteit in en uit de bot stroomt, kan elk onderdeel van middleware de activiteit inspecteren of erop reageren, zowel vóór als nadat de botlogica wordt uitgevoerd.

Constructors

Name	Description
BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Initialiseert een nieuwe instantie van de BotFrameworkAdapter klasse, met behulp van een credentialprovider.
BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Initialiseert een nieuwe instantie van de BotFrameworkAdapter klasse, met behulp van een credentialprovider.
BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Initialiseert een nieuwe instantie van de BotFrameworkAdapter klasse, met behulp van een credentialprovider.

Velden

Name	Description
BotIdentityKey	De tekenreekswaarde voor de bot-id-sleutel. (Overgenomen van BotAdapter)
InvokeResponseKey	De sleutelwaarde voor een InvokeResponseActivity die zich in de TurnState zou kunnen vinden. (Overgenomen van BotAdapter)
OAuthScopeKey	De tekenreekswaarde voor de OAuth-bereiksleutel. (Overgenomen van BotAdapter)

Eigenschappen

Name	Description
AppCredentialMap	Krijgt de kaart van toepassingen voor AppCredentials deze adapter.
ChannelProvider	Hiermee haalt u de kanaalprovider voor deze adapter op.
CredentialProvider	Hiermee haalt u de referentieprovider voor deze adapter op.
HttpClient	Krijgt de custom HttpClient voor deze adapter als dat gespecificeerd is.
Logger	Hiermee haalt u de logger voor deze adapter op.
MiddlewareSet	Haalt de verzameling middleware op in de pijplijn van de adapter. (Overgenomen van BotAdapter)
OnTurnError	Hiermee wordt een fouthandler opgehaald of ingesteld die uitzonderingen in de middleware of toepassing kan ondervangen. (Overgenomen van BotAdapter)

Methoden

Name	Description
BuildCredentialsAsync(String, String)	Logica om een AppCredentials object te bouwen dat gebruikt kan worden om tokens voor deze HttpClient te verkrijgen.
CanProcessOutgoingActivity(Activity)	Mogelijkheid voor subklassen om een uitgaande activiteit te verwerken.
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Verzendt een proactief bericht naar een gesprek. (Overgenomen van BotAdapter)
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	Verzendt een proactief bericht naar een gesprek. (Overgenomen van BotAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	Verzendt een proactief bericht van de bot naar een gesprek.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Verzendt een proactief bericht van de bot naar een gesprek.
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	Verzendt een proactief bericht naar een gesprek. (Overgenomen van BotAdapter)
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	Verzendt een proactief bericht van de bot naar een gesprek.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Hiermee maakt u een gesprek op het opgegeven kanaal.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Verouderd. Hiermee maakt u een gesprek op het opgegeven kanaal. Overbelasting ontvangt een ConversationReference, inclusief de tenant.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Hiermee maakt u een gesprek op het opgegeven kanaal.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Verouderd. Hiermee maakt u een gesprek op het opgegeven kanaal. Overbelasting ontvangt een ConversationReference, inclusief de tenant.
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Hiermee maakt u een gesprek op het opgegeven kanaal. (Overgenomen van BotAdapter)
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	Hiermee maakt u een OAuth-client voor de bot met de referenties.
CreateOAuthApiClientAsync(ITurnContext)	Hiermee maakt u een OAuth-client voor de bot.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Hiermee verwijdert u een bestaande activiteit in het gesprek.
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	Hiermee verwijdert u een lid uit het huidige gesprek.
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	Voert een tokenuitwisselingsbewerking uit, zoals voor eenmalige aanmelding.
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	Voert een tokenuitwisselingsbewerking uit, zoals voor eenmalige aanmelding.
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)	Hiermee haalt u Azure Active Directory-tokens voor bepaalde resources op een geconfigureerde verbinding op met behulp van aangepaste AppCredentials.
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	Haalt Azure Active Directory-tokens op voor bepaalde resources op een geconfigureerde verbinding, met behulp van de AppCredentials van de bot.
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	Geeft een lijst weer van de leden van een bepaalde activiteit.
GetConversationMembersAsync(ITurnContext, CancellationToken)	Geeft een lijst weer van de leden van het huidige gesprek.
GetConversationsAsync(ITurnContext, String, CancellationToken)	Geeft een lijst weer van de gesprekken waarin deze bot heeft deelgenomen aan een bepaalde kanaalserver. De kanaalserver geeft resultaten in pagina's terug en elke pagina bevat een `continuationToken` pagina die gebruikt kan worden om de volgende pagina met resultaten van de server op te halen.
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken)	Geeft een lijst weer van de gesprekken waarin deze bot heeft deelgenomen aan een bepaalde kanaalserver. De kanaalserver geeft resultaten in pagina's terug en elke pagina bevat een `continuationToken` pagina die gebruikt kan worden om de volgende pagina met resultaten van de server op te halen.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	Haal de onbewerkte aanmeldingskoppeling op die naar de gebruiker moet worden verzonden voor aanmelding voor een verbindingsnaam met behulp van aangepaste AppCredentials.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Haal de onbewerkte aanmeldingskoppeling op die naar de gebruiker moet worden verzonden voor aanmelding voor een verbindingsnaam met behulp van aangepaste AppCredentials.
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	Haal de onbewerkte aanmeldingskoppeling op die naar de gebruiker moet worden verzonden voor aanmelding voor een verbindingsnaam met behulp van de AppCredentials van de bot.
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	Haal de onbewerkte aanmeldingskoppeling op die naar de gebruiker moet worden verzonden voor aanmelding voor een verbindingsnaam met behulp van de AppCredentials van de bot.
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Haal de onbewerkte aanmeldingskoppeling op die naar de gebruiker moet worden verzonden voor aanmelding voor een verbindingsnaam.
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	Haal de onbewerkte aanmeldingskoppeling op die naar de gebruiker moet worden verzonden voor aanmelding voor een verbindingsnaam.
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)	Haal de onbewerkte aanmeldingskoppeling op die naar de gebruiker moet worden verzonden voor aanmelding voor een verbindingsnaam.
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Haalt de tokenstatus voor elke geconfigureerde verbinding voor de opgegeven gebruiker op met behulp van aangepaste AppCredentials.
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	Haalt de tokenstatus voor elke geconfigureerde verbinding voor de opgegeven gebruiker op met behulp van de AppCredentials van de bot.
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Probeert het token op te halen voor een gebruiker die zich in een aanmeldingsstroom bevindt, met behulp van aangepaste AppCredentials.
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	Probeert het token op te halen voor een gebruiker die zich in een aanmeldingsstroom bevindt, met behulp van de AppCredentials van de bot.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Hiermee maakt u een turncontext en voert u de middleware-pijplijn uit voor een binnenkomende activiteit.
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	Hiermee maakt u een turncontext en voert u de middleware-pijplijn uit voor een binnenkomende activiteit.
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Aangepaste logica voor het verzenden van een uitgaande activiteit. Subklassen kunnen deze methode overschrijven, samen met CanProcessOutgoingActivity om aangepaste logica te hebben om de uitgaande activiteit te verwerken.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Hiermee start u de activiteitsverwerking voor de huidige botdraai. (Overgenomen van BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	Hiermee worden activiteiten naar het gesprek verzonden.
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Hiermee wordt de gebruiker afgetekend bij de tokenserver met behulp van aangepaste AppCredentials.
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Hiermee wordt de gebruiker afgetekend bij de tokenserver met behulp van de AppCredentials van de bot.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Vervangt een bestaande activiteit in het gesprek.
Use(IMiddleware)	Hiermee voegt u middleware toe aan de pijplijn van de adapter.

Expliciete interface-implementaties

Name	Description
IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)	Een botadapter die een bot kan verbinden met een service-eindpunt.

Extensiemethoden

Name	Description
UseBotState(BotAdapter, BotState[])	Voegt middleware toe aan de adapter om één of meer BotState objecten in de draaicontext te registreren. De middleware registreert de statusobjecten op de turncontext aan het begin van elke beurt.
UseState(BotAdapter, UserState, ConversationState, Boolean)	Verouderd. Registreert gebruikers- en gespreksstatusobjecten met de adapter. Deze objecten zijn beschikbaar via de TurnStatemethodeGet<T>() . van de turn context.
UseStorage(BotAdapter, IStorage)	Voegt middleware toe aan de adapter om een IStorage object te registreren in de draaicontext. De middleware registreert de statusobjecten op de turncontext aan het begin van elke beurt.

Van toepassing op