BotFrameworkHttpAdapterBase Klasa

Definicja

Przestrzeń nazw:: Microsoft.Bot.Builder.Streaming

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.

Klasa podstawowa karty HTTP.

public class BotFrameworkHttpAdapterBase : Microsoft.Bot.Builder.BotFrameworkAdapter, IDisposable, Microsoft.Bot.Builder.Streaming.IStreamingActivityProcessor

type BotFrameworkHttpAdapterBase = class
    inherit BotFrameworkAdapter
    interface IStreamingActivityProcessor
    interface IDisposable

Public Class BotFrameworkHttpAdapterBase
Inherits BotFrameworkAdapter
Implements IDisposable, IStreamingActivityProcessor

Dziedziczenie: Object

BotAdapter

BotFrameworkAdapter
BotFrameworkHttpAdapterBase

Pochodne: Microsoft.Bot.Builder.Integration.AspNet.Core.BotFrameworkHttpAdapter

Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkHttpAdapter

Implementuje: IStreamingActivityProcessor IDisposable

Uwagi

BotFrameworkAdapter jest nadal obsługiwany, ale zalecany adapter to CloudAdapter.

Konstruktory

Nazwa	Opis
BotFrameworkHttpAdapterBase(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inicjuje nowe wystąpienie klasy BotFrameworkHttpAdapterBase.
BotFrameworkHttpAdapterBase(ICredentialProvider, IChannelProvider, HttpClient, ILogger<BotFrameworkHttpAdapterBase>)	Inicjuje nowe wystąpienie klasy BotFrameworkHttpAdapterBase.
BotFrameworkHttpAdapterBase(ICredentialProvider, IChannelProvider, ILogger<BotFrameworkHttpAdapterBase>)	Inicjuje nowe wystąpienie klasy BotFrameworkHttpAdapterBase.

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. (Odziedziczone po BotFrameworkAdapter)
ChannelProvider	Pobiera dostawcę kanału dla tej karty. (Odziedziczone po BotFrameworkAdapter)
ClaimsIdentity	Pobiera lub ustawia tożsamość oświadczeń dla tej karty.
ConnectedBot	Pobiera lub ustawia bota podłączonego do tej karty.
CredentialProvider	Pobiera dostawcę poświadczeń dla tej karty. (Odziedziczone po BotFrameworkAdapter)
HttpClient	Dostaje customowy HttpClient adapter do tego adaptera, jeśli jest to zaznaczone. (Odziedziczone po BotFrameworkAdapter)
Logger	Pobiera rejestrator dla tej karty. (Odziedziczone po BotFrameworkAdapter)
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)
RequestHandlers	Pobiera lub ustawia programy obsługi żądań dla tej karty.

Metody

Nazwa	Opis
BuildCredentialsAsync(String, String)	Logika budowy obiektu AppCredentials do pozyskiwania tokenów dla tego HttpClienta. (Odziedziczone po BotFrameworkAdapter)
CanProcessOutgoingActivity(Activity)	Ocenia, czy przetwarzanie działania wychodzącego jest możliwe.
ConnectNamedPipeAsync(String, IBot, String)	Tworzy nową procedurę StreamingRequestHandler w celu nasłuchiwania określonego nazwanego potoku i przekazywania żądań do tej karty.
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. (Odziedziczone po BotFrameworkAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Wysyła proaktywny komunikat z bota do konwersacji. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Tworzy konwersację w określonym kanale. (Odziedziczone po BotFrameworkAdapter)
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ę. (Odziedziczone po BotFrameworkAdapter)
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Tworzy konwersację w określonym kanale. (Odziedziczone po BotFrameworkAdapter)
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ę. (Odziedziczone po BotFrameworkAdapter)
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ń. (Odziedziczone po BotFrameworkAdapter)
CreateOAuthApiClientAsync(ITurnContext)	Tworzy klienta OAuth dla bota. (Odziedziczone po BotFrameworkAdapter)
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Usuwa istniejące działanie w konwersacji. (Odziedziczone po BotFrameworkAdapter)
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	Usuwa członka z bieżącej konwersacji. (Odziedziczone po BotFrameworkAdapter)
Dispose()	Klasa podstawowa karty HTTP.
Dispose(Boolean)	Dysponuje zasobami .StreamingRequestHandler
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	Wykonuje operację wymiany tokenów, taką jak na potrzeby logowania jednokrotnego. (Odziedziczone po BotFrameworkAdapter)
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	Wykonuje operację wymiany tokenów, taką jak na potrzeby logowania jednokrotnego. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	Wyświetla listę członków danego działania. (Odziedziczone po BotFrameworkAdapter)
GetConversationMembersAsync(ITurnContext, CancellationToken)	Wyświetla listę członków bieżącej konwersacji. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	Pobiera stan tokenu dla każdego skonfigurowanego połączenia dla danego użytkownika przy użyciu funkcji AppCredentials bota. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
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. (Odziedziczone po BotFrameworkAdapter)
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Tworzy kontekst kolei i uruchamia potok oprogramowania pośredniczącego dla działania przychodzącego. (Odziedziczone po BotFrameworkAdapter)
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	Tworzy kontekst kolei i uruchamia potok oprogramowania pośredniczącego dla działania przychodzącego. (Odziedziczone po BotFrameworkAdapter)
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Wysyła działanie wychodzące.
ProcessStreamingActivityAsync(Activity, BotCallbackHandler, CancellationToken)	Podstawowa metoda karty do przetwarzania działań wysyłanych z kanału przesyłania strumieniowego. Tworzy kontekst kolei i uruchamia potok oprogramowania pośredniczącego dla działania przychodzącego. Dodaje ArgumentNullException argumenty nieważne.
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. (Odziedziczone po BotFrameworkAdapter)
SendStreamingActivityAsync(Activity, CancellationToken)	Wysyła działanie.
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Podpisuje użytkownika z serwerem tokenów przy użyciu dostosowanych obiektów AppCredentials. (Odziedziczone po BotFrameworkAdapter)
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Podpisuje użytkownika z serwerem tokenów przy użyciu funkcji AppCredentials bota. (Odziedziczone po BotFrameworkAdapter)
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Zastępuje istniejące działanie w konwersacji. (Odziedziczone po BotFrameworkAdapter)
Use(IMiddleware)	Dodaje oprogramowanie pośredniczące do potoku karty. (Odziedziczone po BotFrameworkAdapter)

Jawne implementacje interfejsu

Nazwa	Opis
IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)	Klasa podstawowa karty HTTP. (Odziedziczone po BotFrameworkAdapter)

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