BotFrameworkAdapter Klasa

Definicja

Przestrzeń nazw:: Microsoft.Bot.Builder

Zestaw:: Microsoft.Bot.Builder.dll

Pakiet:: Microsoft.Bot.Builder v4.22.7

Ważne

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Adapter bota, który może połączyć bota z punktem końcowym usługi.

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

Dziedziczenie: Object

BotAdapter
BotFrameworkAdapter

Pochodne: Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase

Implementuje: IExtendedUserTokenProvider IAdapterIntegration IUserTokenProvider IConnectorClientBuilder

Uwagi

BotFrameworkAdapter jest nadal obsługiwany, ale zalecana karta to "CloudAdapter". Karta bota hermetyzuje procesy uwierzytelniania i wysyła działania do i odbiera działania z usługi Bot Connector Service. Gdy bot odbiera działanie, karta tworzy obiekt kontekstu, przekazuje go do logiki aplikacji bota i wysyła odpowiedzi z powrotem do kanału użytkownika.

Użyj Use(IMiddleware) do dodawania IMiddleware obiektów do kolekcji middleware twojego adaptera. Adapter przetwarza i kieruje przychodzące działania za pośrednictwem potoku oprogramowania pośredniczącego bota do logiki bota, a następnie ponownie powraca. Gdy każde działanie przepływa do i z bota, każdy element oprogramowania pośredniczącego może sprawdzać działanie lub wykonywać działania, zarówno przed, jak i po uruchomieniu logiki bota.

Konstruktory

Nazwa	Opis
BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inicjalizuje nową instancję BotFrameworkAdapter klasy, korzystając z dostawcy poświadczeń.
BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inicjalizuje nową instancję BotFrameworkAdapter klasy, korzystając z dostawcy poświadczeń.
BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inicjalizuje nową instancję BotFrameworkAdapter klasy, korzystając z dostawcy poświadczeń.

Pola

Nazwa	Opis
BotIdentityKey	Wartość ciągu klucza tożsamości bota. (Odziedziczone po BotAdapter)
InvokeResponseKey	Wartość klucza dla dowolnego elementu InvokeResponseActivity, która będzie miała wartość TurnState. (Odziedziczone po BotAdapter)
OAuthScopeKey	Wartość ciągu klucza zakresu OAuth. (Odziedziczone po BotAdapter)

Właściwości

Nazwa	Opis
AppCredentialMap	Otrzymuje mapę zastosowań AppCredentials dla tego adaptera.
ChannelProvider	Pobiera dostawcę kanału dla tej karty.
CredentialProvider	Pobiera dostawcę poświadczeń dla tej karty.
HttpClient	Dostaje customowy HttpClient adapter do tego adaptera, jeśli jest to zaznaczone.
Logger	Pobiera rejestrator dla tej karty.
MiddlewareSet	Pobiera kolekcję oprogramowania pośredniczącego w potoku karty. (Odziedziczone po BotAdapter)
OnTurnError	Pobiera lub ustawia procedurę obsługi błędów, która może przechwytywać wyjątki w programie pośredniczącym lub aplikacji. (Odziedziczone po BotAdapter)

Metody

Nazwa	Opis
BuildCredentialsAsync(String, String)	Logika budowy obiektu AppCredentials do pozyskiwania tokenów dla tego HttpClienta.
CanProcessOutgoingActivity(Activity)	Możliwość wyboru podklas w celu przetworzenia działania wychodzącego.
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Wysyła proaktywną wiadomość do konwersacji. (Odziedziczone po BotAdapter)
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	Wysyła proaktywną wiadomość do konwersacji. (Odziedziczone po BotAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	Wysyła proaktywny komunikat z bota do konwersacji.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Wysyła proaktywny komunikat z bota do konwersacji.
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	Wysyła proaktywną wiadomość do konwersacji. (Odziedziczone po BotAdapter)
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	Wysyła proaktywny komunikat z bota do konwersacji.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Tworzy konwersację w określonym kanale.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Przestarzałe. Tworzy konwersację w określonym kanale. Przeciążenie odbiera element ConversationReference, w tym dzierżawę.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Tworzy konwersację w określonym kanale.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Przestarzałe. Tworzy konwersację w określonym kanale. Przeciążenie odbiera element ConversationReference, w tym dzierżawę.
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Tworzy konwersację w określonym kanale. (Odziedziczone po BotAdapter)
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	Tworzy klienta OAuth dla bota przy użyciu poświadczeń.
CreateOAuthApiClientAsync(ITurnContext)	Tworzy klienta OAuth dla bota.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Usuwa istniejące działanie w konwersacji.
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	Usuwa członka z bieżącej konwersacji.
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	Wykonuje operację wymiany tokenów, taką jak na potrzeby logowania jednokrotnego.
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	Wykonuje operację wymiany tokenów, taką jak na potrzeby logowania jednokrotnego.
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)	Pobiera tokeny usługi Azure Active Directory dla określonych zasobów w skonfigurowanym połączeniu przy użyciu dostosowanych obiektów AppCredentials.
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	Pobiera tokeny usługi Azure Active Directory dla określonych zasobów w skonfigurowanym połączeniu przy użyciu funkcji AppCredentials bota.
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	Wyświetla listę członków danego działania.
GetConversationMembersAsync(ITurnContext, CancellationToken)	Wyświetla listę członków bieżącej konwersacji.
GetConversationsAsync(ITurnContext, String, CancellationToken)	Wyświetla listę konwersacji, w których ten bot brał udział w danym serwerze kanału. Serwer kanałowy zwraca wyniki w formie stron, a każda strona zawiera , `continuationToken` którą można użyć do pobrania kolejnej strony wyników z serwera.
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken)	Wyświetla listę konwersacji, w których ten bot brał udział w danym serwerze kanału. Serwer kanałowy zwraca wyniki w formie stron, a każda strona zawiera , `continuationToken` którą można użyć do pobrania kolejnej strony wyników z serwera.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	Pobierz link nieprzetworzonego logowania, który ma zostać wysłany do użytkownika na potrzeby logowania w celu uzyskania nazwy połączenia przy użyciu dostosowanych instrukcji AppCredentials.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Pobierz link nieprzetworzonego logowania, który ma zostać wysłany do użytkownika na potrzeby logowania w celu uzyskania nazwy połączenia przy użyciu dostosowanych instrukcji AppCredentials.
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	Pobierz link nieprzetworzonego logowania, który ma zostać wysłany do użytkownika na potrzeby logowania w celu uzyskania nazwy połączenia, używając identyfikatorów AppCredentials bota.
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	Pobierz link nieprzetworzonego logowania, który ma zostać wysłany do użytkownika na potrzeby logowania w celu uzyskania nazwy połączenia, używając identyfikatorów AppCredentials bota.
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Pobierz link nieprzetworzonego logowania, który ma zostać wysłany do użytkownika na potrzeby logowania w celu uzyskania nazwy połączenia.
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	Pobierz link nieprzetworzonego logowania, który ma zostać wysłany do użytkownika na potrzeby logowania w celu uzyskania nazwy połączenia.
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)	Pobierz link nieprzetworzonego logowania, który ma zostać wysłany do użytkownika na potrzeby logowania w celu uzyskania nazwy połączenia.
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Pobiera stan tokenu dla każdego skonfigurowanego połączenia dla danego użytkownika przy użyciu dostosowanych instrukcji AppCredentials.
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	Pobiera stan tokenu dla każdego skonfigurowanego połączenia dla danego użytkownika przy użyciu funkcji AppCredentials bota.
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Próbuje pobrać token dla użytkownika, który znajduje się w przepływie logowania, przy użyciu dostosowanych instrukcji AppCredentials.
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	Próbuje pobrać token dla użytkownika, który znajduje się w przepływie logowania, przy użyciu funkcji AppCredentials bota.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Tworzy kontekst kolei i uruchamia potok oprogramowania pośredniczącego dla działania przychodzącego.
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	Tworzy kontekst kolei i uruchamia potok oprogramowania pośredniczącego dla działania przychodzącego.
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Niestandardowa logika wysyłania działań wychodzących. Podklasy mogą zastąpić tę metodę wraz z canProcessOutgoingActivity, aby mieć niestandardową logikę przetwarzania działań wychodzących.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Uruchamia przetwarzanie działań dla bieżącego kolei bota. (Odziedziczone po BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	Wysyła działania do konwersacji.
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Podpisuje użytkownika z serwerem tokenów przy użyciu dostosowanych obiektów AppCredentials.
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Podpisuje użytkownika z serwerem tokenów przy użyciu funkcji AppCredentials bota.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Zastępuje istniejące działanie w konwersacji.
Use(IMiddleware)	Dodaje oprogramowanie pośredniczące do potoku karty.

Jawne implementacje interfejsu

Nazwa	Opis
IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)	Adapter bota, który może połączyć bota z punktem końcowym usługi.

Metody rozszerzania

Nazwa	Opis
UseBotState(BotAdapter, BotState[])	Dodaje middleware do adaptera, aby rejestrować jeden lub więcej BotState obiektów w kontekście tury. Oprogramowanie pośredniczące rejestruje obiekty stanu w kontekście turn na początku każdego kolei.
UseState(BotAdapter, UserState, ConversationState, Boolean)	Przestarzałe. Rejestruje obiekty stanu użytkownika i konwersacji za pomocą karty. Obiekty te będą dostępne za pomocą metody .Get<T>() w kontekście TurnStatetur.
UseStorage(BotAdapter, IStorage)	Dodaje middleware do adaptera, aby rejestrować IStorage obiekt w kontekście tury. Oprogramowanie pośredniczące rejestruje obiekty stanu w kontekście turn na początku każdego kolei.

Dotyczy