BotFrameworkHttpAdapterBase Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Základní třída adaptéru 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
- Dědičnost
- Odvozené
- Implementuje
Poznámky
BotFrameworkAdapter je stále podporován, ale doporučený adaptér je CloudAdapter.
Konstruktory
| Name | Description |
|---|---|
| BotFrameworkHttpAdapterBase(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger) |
Inicializuje novou instanci BotFrameworkHttpAdapterBase třídy. |
| BotFrameworkHttpAdapterBase(ICredentialProvider, IChannelProvider, HttpClient, ILogger<BotFrameworkHttpAdapterBase>) |
Inicializuje novou instanci BotFrameworkHttpAdapterBase třídy. |
| BotFrameworkHttpAdapterBase(ICredentialProvider, IChannelProvider, ILogger<BotFrameworkHttpAdapterBase>) |
Inicializuje novou instanci BotFrameworkHttpAdapterBase třídy. |
Pole
| Name | Description |
|---|---|
| BotIdentityKey |
Řetězcová hodnota klíče identity robota. (Zděděno od BotAdapter) |
| InvokeResponseKey |
Hodnota klíče pro všechny InvokeResponseActivity, které by byly na TurnState. (Zděděno od BotAdapter) |
| OAuthScopeKey |
Hodnota řetězce pro klíč oboru OAuth. (Zděděno od BotAdapter) |
Vlastnosti
| Name | Description |
|---|---|
| AppCredentialMap |
Získá mapu aplikací pro AppCredentials tento adaptér. (Zděděno od BotFrameworkAdapter) |
| ChannelProvider |
Získá poskytovatele kanálu pro tento adaptér. (Zděděno od BotFrameworkAdapter) |
| ClaimsIdentity |
Získá nebo nastaví identitu deklarací identity pro tento adaptér. |
| ConnectedBot |
Získá nebo nastaví robota připojeného k tomuto adaptéru. |
| CredentialProvider |
Získá zprostředkovatele přihlašovacích údajů pro tento adaptér. (Zděděno od BotFrameworkAdapter) |
| HttpClient |
Pokud je to specifikováno, dostane si vlastní HttpClient adaptér. (Zděděno od BotFrameworkAdapter) |
| Logger |
Získá protokolovací nástroje pro tento adaptér. (Zděděno od BotFrameworkAdapter) |
| MiddlewareSet |
Získá kolekci middlewaru v kanálu adaptéru. (Zděděno od BotAdapter) |
| OnTurnError |
Získá nebo nastaví obslužnou rutinu chyby, která může zachytit výjimky v middlewaru nebo aplikaci. (Zděděno od BotAdapter) |
| RequestHandlers |
Získá nebo nastaví obslužné rutiny žádosti pro tento adaptér. |
Metody
| Name | Description |
|---|---|
| BuildCredentialsAsync(String, String) |
Logika pro vytvoření objektu, který AppCredentials slouží k získávání tokenů pro tento HttpClient. (Zděděno od BotFrameworkAdapter) |
| CanProcessOutgoingActivity(Activity) |
Vyhodnotí, jestli je možné zpracovat odchozí aktivitu. |
| ConnectNamedPipeAsync(String, IBot, String) |
Vytvoří novou StreamRequestHandler pro naslouchání zadanému pojmenovaného kanálu a předání požadavků tomuto adaptéru. |
| ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken) |
Odešle proaktivní zprávu do konverzace. (Zděděno od BotAdapter) |
| ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken) |
Odešle proaktivní zprávu do konverzace. (Zděděno od BotAdapter) |
| ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken) |
Odešle proaktivní zprávu z robota do konverzace. (Zděděno od BotFrameworkAdapter) |
| ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken) |
Odešle proaktivní zprávu z robota do konverzace. (Zděděno od BotFrameworkAdapter) |
| ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken) |
Odešle proaktivní zprávu do konverzace. (Zděděno od BotAdapter) |
| ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken) |
Odešle proaktivní zprávu z robota do konverzace. (Zděděno od BotFrameworkAdapter) |
| CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken) |
Vytvoří konverzaci v zadaném kanálu. (Zděděno od BotFrameworkAdapter) |
| CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken) |
Zastaralé.
Vytvoří konverzaci v zadaném kanálu. Přetížení obdrží Konverzačníreference včetně tenanta. (Zděděno od BotFrameworkAdapter) |
| CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken) |
Vytvoří konverzaci v zadaném kanálu. (Zděděno od BotFrameworkAdapter) |
| CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken) |
Zastaralé.
Vytvoří konverzaci v zadaném kanálu. Přetížení obdrží Konverzačníreference včetně tenanta. (Zděděno od BotFrameworkAdapter) |
| CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken) |
Vytvoří konverzaci v zadaném kanálu. (Zděděno od BotAdapter) |
| CreateOAuthApiClientAsync(ITurnContext, AppCredentials) |
Vytvoří klienta OAuth pro robota s přihlašovacími údaji. (Zděděno od BotFrameworkAdapter) |
| CreateOAuthApiClientAsync(ITurnContext) |
Vytvoří klienta OAuth pro robota. (Zděděno od BotFrameworkAdapter) |
| DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken) |
Odstraní existující aktivitu v konverzaci. (Zděděno od BotFrameworkAdapter) |
| DeleteConversationMemberAsync(ITurnContext, String, CancellationToken) |
Odebere člena z aktuální konverzace. (Zděděno od BotFrameworkAdapter) |
| Dispose() |
Základní třída adaptéru HTTP. |
| Dispose(Boolean) |
Likviduje zdroje .StreamingRequestHandler |
| ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken) |
Provede operaci výměny tokenů, například pro jednotné přihlašování. (Zděděno od BotFrameworkAdapter) |
| ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken) |
Provede operaci výměny tokenů, například pro jednotné přihlašování. (Zděděno od BotFrameworkAdapter) |
| GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken) |
Načte tokeny Azure Active Directory pro konkrétní prostředky nakonfigurovaného připojení pomocí přizpůsobených appCredentials. (Zděděno od BotFrameworkAdapter) |
| GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken) |
Načte tokeny Azure Active Directory pro konkrétní prostředky v nakonfigurované připojení pomocí AppCredentials robota. (Zděděno od BotFrameworkAdapter) |
| GetActivityMembersAsync(ITurnContext, String, CancellationToken) |
Zobrazí seznam členů dané aktivity. (Zděděno od BotFrameworkAdapter) |
| GetConversationMembersAsync(ITurnContext, CancellationToken) |
Zobrazí seznam členů aktuální konverzace. (Zděděno od BotFrameworkAdapter) |
| GetConversationsAsync(ITurnContext, String, CancellationToken) |
Zobrazí seznam konverzací, kterých se tento robot zúčastnil pro daný server kanálu. Kanálový server vrací výsledky ve formě stránek a každá stránka obsahuje , |
| GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken) |
Zobrazí seznam konverzací, kterých se tento robot zúčastnil pro daný server kanálu. Kanálový server vrací výsledky ve formě stránek a každá stránka obsahuje , |
| GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken) |
Pomocí přizpůsobených appCredentials získejte nezpracovaný přihlašovací odkaz, který se má odeslat uživateli, aby se přihlásil k názvu připojení. (Zděděno od BotFrameworkAdapter) |
| GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken) |
Pomocí přizpůsobených appCredentials získejte nezpracovaný přihlašovací odkaz, který se má odeslat uživateli, aby se přihlásil k názvu připojení. (Zděděno od BotFrameworkAdapter) |
| GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken) |
Pomocí appCredentials robota získejte nezpracovaný přihlašovací odkaz, který se má odeslat uživateli, aby se přihlásil k názvu připojení. (Zděděno od BotFrameworkAdapter) |
| GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken) |
Pomocí appCredentials robota získejte nezpracovaný přihlašovací odkaz, který se má odeslat uživateli, aby se přihlásil k názvu připojení. (Zděděno od BotFrameworkAdapter) |
| GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken) |
Získejte nezpracovaný odkaz pro přihlášení, který se má odeslat uživateli pro přihlášení k názvu připojení. (Zděděno od BotFrameworkAdapter) |
| GetSignInResourceAsync(ITurnContext, String, CancellationToken) |
Získejte nezpracovaný odkaz pro přihlášení, který se má odeslat uživateli pro přihlášení k názvu připojení. (Zděděno od BotFrameworkAdapter) |
| GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken) |
Získejte nezpracovaný odkaz pro přihlášení, který se má odeslat uživateli pro přihlášení k názvu připojení. (Zděděno od BotFrameworkAdapter) |
| GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Načte stav tokenu pro každé nakonfigurované připojení pro daného uživatele pomocí přizpůsobených AppCredentials. (Zděděno od BotFrameworkAdapter) |
| GetTokenStatusAsync(ITurnContext, String, String, CancellationToken) |
Načte stav tokenu pro každé nakonfigurované připojení pro daného uživatele pomocí appCredentials robota. (Zděděno od BotFrameworkAdapter) |
| GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Pokusí se načíst token pro uživatele, který je v toku přihlášení, pomocí přizpůsobených AppCredentials. (Zděděno od BotFrameworkAdapter) |
| GetUserTokenAsync(ITurnContext, String, String, CancellationToken) |
Pokusí se načíst token pro uživatele, který je v toku přihlášení, pomocí AppCredentials robota. (Zděděno od BotFrameworkAdapter) |
| ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken) |
Vytvoří kontext otáčení a spustí kanál middlewaru pro příchozí aktivitu. (Zděděno od BotFrameworkAdapter) |
| ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken) |
Vytvoří kontext otáčení a spustí kanál middlewaru pro příchozí aktivitu. (Zděděno od BotFrameworkAdapter) |
| ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken) |
Odešle odchozí aktivitu. |
| ProcessStreamingActivityAsync(Activity, BotCallbackHandler, CancellationToken) |
Primární metoda adaptéru pro zpracování aktivit odeslaných z kanálu streamování Vytvoří kontext otáčení a spustí kanál middlewaru pro příchozí aktivitu. Přidává ArgumentNullException k tomu nulové argumenty. |
| RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken) |
Spustí zpracování aktivit pro aktuální otáčení robota. (Zděděno od BotAdapter) |
| SendActivitiesAsync(ITurnContext, Activity[], CancellationToken) |
Odesílá aktivity do konverzace. (Zděděno od BotFrameworkAdapter) |
| SendStreamingActivityAsync(Activity, CancellationToken) |
Odešle aktivitu. |
| SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Odhlásí uživatele pomocí serveru tokenů pomocí přizpůsobených appCredentials. (Zděděno od BotFrameworkAdapter) |
| SignOutUserAsync(ITurnContext, String, String, CancellationToken) |
Odhlásí uživatele pomocí serveru tokenů pomocí AppCredentials robota. (Zděděno od BotFrameworkAdapter) |
| UpdateActivityAsync(ITurnContext, Activity, CancellationToken) |
Nahradí existující aktivitu v konverzaci. (Zděděno od BotFrameworkAdapter) |
| Use(IMiddleware) |
Přidá middleware do kanálu adaptéru. (Zděděno od BotFrameworkAdapter) |
Explicitní implementace rozhraní
| Name | Description |
|---|---|
| IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken) |
Základní třída adaptéru HTTP. (Zděděno od BotFrameworkAdapter) |
Metody rozšíření
| Name | Description |
|---|---|
| UseBotState(BotAdapter, BotState[]) |
Přidává middleware do adaptéru, aby registroval jeden nebo více BotState objektů v kontextu tahu. Middleware zaregistruje stavové objekty na kontext zapnutí na začátku každého turnu. |
| UseState(BotAdapter, UserState, ConversationState, Boolean) |
Zastaralé.
Zaregistruje u adaptéru objekty stavu uživatele a konverzace. Tyto objekty budou dostupné pomocí metody .TurnState v kontextu Get<T>()tahů. |
| UseStorage(BotAdapter, IStorage) |
Přidává middleware do adaptéru, aby registroval IStorage objekt v kontextu tahu. Middleware zaregistruje stavové objekty na kontext zapnutí na začátku každého turnu. |