BotFrameworkAdapter Třída

Definice

Obor názvů:: Microsoft.Bot.Builder

Sestavení:: Microsoft.Bot.Builder.dll

Balíček:: Microsoft.Bot.Builder v4.22.7

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í.

Adaptér robota, který může připojit robota ke koncovému bodu služby.

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

Dědičnost: Object

BotAdapter
BotFrameworkAdapter

Odvozené: Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase

Implementuje: IExtendedUserTokenProvider IAdapterIntegration IUserTokenProvider IConnectorClientBuilder

Poznámky

BotFrameworkAdapter je stále podporován, ale doporučený adaptér je CloudAdapter. Adaptér robota zapouzdřuje procesy ověřování a odesílá aktivity do služby Bot Connector Service a přijímá aktivity. Když robot přijme aktivitu, adaptér vytvoří kontextový objekt, předá ho do logiky aplikace robota a odešle odpovědi zpět do kanálu uživatele.

Použijte Use(IMiddleware) k přidání IMiddleware objektů do kolekce middleware vašeho adaptéru. Adaptér zpracovává a směruje příchozí aktivity prostřednictvím kanálu middlewaru robota do logiky robota a pak se zase vrátí zpět. Vzhledem k tomu, že každá aktivita prochází robotem i mimo robota, může každá část middlewaru zkontrolovat nebo reagovat na danou aktivitu, a to jak před, tak i po spuštění logiky robota.

Konstruktory

Name	Description
BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inicializuje novou instanci třídy BotFrameworkAdapter pomocí poskytovatele přihlašovacích údajů.
BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inicializuje novou instanci třídy BotFrameworkAdapter pomocí poskytovatele přihlašovacích údajů.
BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inicializuje novou instanci třídy BotFrameworkAdapter pomocí poskytovatele přihlašovacích údajů.

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.
ChannelProvider	Získá poskytovatele kanálu pro tento adaptér.
CredentialProvider	Získá zprostředkovatele přihlašovacích údajů pro tento adaptér.
HttpClient	Pokud je to specifikováno, dostane si vlastní HttpClient adaptér.
Logger	Získá protokolovací nástroje pro tento adaptér.
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)

Metody

Name	Description
BuildCredentialsAsync(String, String)	Logika pro vytvoření objektu, který AppCredentials slouží k získávání tokenů pro tento HttpClient.
CanProcessOutgoingActivity(Activity)	Příležitost pro podtřídy, aby se přihlásili ke zpracování odchozí aktivity.
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.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Odešle proaktivní zprávu z robota do konverzace.
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.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Vytvoří konverzaci v zadaném kanálu.
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.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Vytvoří konverzaci v zadaném kanálu.
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.
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.
CreateOAuthApiClientAsync(ITurnContext)	Vytvoří klienta OAuth pro robota.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Odstraní existující aktivitu v konverzaci.
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	Odebere člena z aktuální konverzace.
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	Provede operaci výměny tokenů, například pro jednotné přihlašování.
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	Provede operaci výměny tokenů, například pro jednotné přihlašování.
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.
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	Načte tokeny Azure Active Directory pro konkrétní prostředky v nakonfigurované připojení pomocí AppCredentials robota.
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	Zobrazí seznam členů dané aktivity.
GetConversationMembersAsync(ITurnContext, CancellationToken)	Zobrazí seznam členů aktuální konverzace.
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 , `continuationToken` kterou lze použít k načtení další stránky výsledků ze serveru.
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 , `continuationToken` kterou lze použít k načtení další stránky výsledků ze serveru.
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í.
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í.
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í.
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í.
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í.
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í.
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í.
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.
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	Načte stav tokenu pro každé nakonfigurované připojení pro daného uživatele pomocí appCredentials robota.
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.
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	Pokusí se načíst token pro uživatele, který je v toku přihlášení, pomocí AppCredentials robota.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Vytvoří kontext otáčení a spustí kanál middlewaru pro příchozí aktivitu.
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	Vytvoří kontext otáčení a spustí kanál middlewaru pro příchozí aktivitu.
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Vlastní logika pro odesílání odchozí aktivity Podtřídy mohou tuto metodu přepsat spolu s CanProcessOutgoingActivity, aby měla vlastní logiku pro zpracování odchozí aktivity.
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.
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Odhlásí uživatele pomocí serveru tokenů pomocí přizpůsobených appCredentials.
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Odhlásí uživatele pomocí serveru tokenů pomocí AppCredentials robota.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Nahradí existující aktivitu v konverzaci.
Use(IMiddleware)	Přidá middleware do kanálu adaptéru.

Explicitní implementace rozhraní

Name	Description
IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)	Adaptér robota, který může připojit robota ke koncovému bodu služby.

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 .Get<T>() v kontextu TurnStatetahů.
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.

Platí pro