BotFrameworkAdapter Osztály
Definíció
Fontos
Egyes információk olyan, kiadás előtti termékekre vonatkoznak, amelyek a kiadásig még jelentősen módosulhatnak. A Microsoft nem vállal kifejezett vagy törvényi garanciát az itt megjelenő információért.
Egy robotadapter, amely csatlakoztathat egy robotot egy szolgáltatásvégponthoz.
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
- Öröklődés
- Származtatott
- Megvalósítás
Megjegyzések
A BotFrameworkAdapter továbbra is támogatott, de az ajánlott adapter a "CloudAdapter". A robotadapter magában foglalja a hitelesítési folyamatokat, és tevékenységeket küld és fogad a Bot Connector service-ből. Amikor a robot kap egy tevékenységet, az adapter létrehoz egy környezeti objektumot, átadja azt a robot alkalmazáslogikája számára, és visszaküldi a válaszokat a felhasználó csatornájára.
A Use(IMiddleware) használatával IMiddleware objektumokat adhat hozzá az adapter köztes szoftvergyűjteményéhez. Az adapter feldolgozza és irányítja a bejövő tevékenységeket a robot köztes szoftver folyamatán keresztül a robot logikájához, majd visszafelé. Mivel minden tevékenység a roboton belül és kívül folyik, minden köztes szoftver megvizsgálhatja vagy elvégezheti a tevékenységet a robotlogika futtatása előtt és után is.
Konstruktorok
| BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger) |
Inicializálja a BotFrameworkAdapter osztály új példányát egy hitelesítőadat-szolgáltató használatával. |
| BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger) |
Inicializálja a BotFrameworkAdapter osztály új példányát egy hitelesítőadat-szolgáltató használatával. |
| BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger) |
Inicializálja a BotFrameworkAdapter osztály új példányát egy hitelesítőadat-szolgáltató használatával. |
Mezők
| BotIdentityKey |
A robot identitáskulcsának sztringértéke. (Öröklődés forrása BotAdapter) |
| InvokeResponseKey |
A TurnState-on található Bármely InvokeResponseActivity kulcsértéke. (Öröklődés forrása BotAdapter) |
| OAuthScopeKey |
Az OAuth-hatókörkulcs sztringértéke. (Öröklődés forrása BotAdapter) |
Tulajdonságok
| AppCredentialMap |
Lekéri az alkalmazástérképet az adapter AppCredentials. |
| ChannelProvider |
Lekéri az adapter csatornaszolgáltatója. |
| CredentialProvider |
Lekéri az adapter hitelesítőadat-szolgáltatójának adatait. |
| HttpClient |
Ha meg van adva, lekéri az adapter egyéni HttpClient. |
| Logger |
Lekéri az adapterhez tartozó naplózót. |
| MiddlewareSet |
Lekéri a köztes szoftver gyűjteményét az adapter folyamatában. (Öröklődés forrása BotAdapter) |
| OnTurnError |
Lekéri vagy beállít egy hibakezelőt, amely képes kivételeket észlelni a köztes szoftverben vagy alkalmazásban. (Öröklődés forrása BotAdapter) |
Metódusok
| BuildCredentialsAsync(String, String) |
A HttpClient-jogkivonatok beszerzéséhez használandó AppCredentials objektum felépítésének logikája. |
| CanProcessOutgoingActivity(Activity) |
Lehetőség arra, hogy az alosztályok résztvehessenek a kimenő tevékenységek feldolgozásában. |
| ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken) |
Proaktív üzenetet küld egy beszélgetésnek. (Öröklődés forrása BotAdapter) |
| ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken) |
Proaktív üzenetet küld egy beszélgetésnek. (Öröklődés forrása BotAdapter) |
| ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken) |
Proaktív üzenetet küld a robottól egy beszélgetéshez. |
| ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken) |
Proaktív üzenetet küld a robottól egy beszélgetéshez. |
| ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken) |
Proaktív üzenetet küld egy beszélgetésnek. (Öröklődés forrása BotAdapter) |
| ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken) |
Proaktív üzenetet küld a robottól egy beszélgetéshez. |
| CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken) |
Beszélgetés létrehozása a megadott csatornán. |
| CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken) |
Elavult.
Beszélgetés létrehozása a megadott csatornán. A túlterhelés egy ConversationReference-t kap, beleértve a bérlőt is. |
| CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken) |
Beszélgetés létrehozása a megadott csatornán. |
| CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken) |
Elavult.
Beszélgetés létrehozása a megadott csatornán. A túlterhelés egy ConversationReference-t kap, beleértve a bérlőt is. |
| CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken) |
Beszélgetés létrehozása a megadott csatornán. (Öröklődés forrása BotAdapter) |
| CreateOAuthApiClientAsync(ITurnContext) |
Létrehoz egy OAuth-ügyfelet a robothoz. |
| CreateOAuthApiClientAsync(ITurnContext, AppCredentials) |
Létrehoz egy OAuth-ügyfelet a robot számára a hitelesítő adatokkal. |
| DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken) |
Töröl egy meglévő tevékenységet a beszélgetésben. |
| DeleteConversationMemberAsync(ITurnContext, String, CancellationToken) |
Eltávolít egy tagot az aktuális beszélgetésből. |
| ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken) |
Tokencsere műveletet hajt végre, például egyszeri bejelentkezés esetén. |
| ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken) |
Tokencsere műveletet hajt végre, például egyszeri bejelentkezés esetén. |
| GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken) |
Azure Active Directory-jogkivonatokat kér le adott erőforrásokhoz egy konfigurált kapcsolaton, testreszabott alkalmazás-hitelesítő adatok használatával. |
| GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken) |
Lekéri az Azure Active Directory-jogkivonatokat egy konfigurált kapcsolat adott erőforrásaihoz a robot alkalmazás hitelesítő adataival. |
| GetActivityMembersAsync(ITurnContext, String, CancellationToken) |
Egy adott tevékenység tagjait sorolja fel. |
| GetConversationMembersAsync(ITurnContext, CancellationToken) |
Az aktuális beszélgetés tagjait sorolja fel. |
| GetConversationsAsync(ITurnContext, String, CancellationToken) |
Felsorolja azokat a beszélgetéseket, amelyekben a robot részt vett egy adott csatornakiszolgálón. A csatornakiszolgáló lapokban adja vissza az eredményeket, és minden lap tartalmaz egy |
| GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken) |
Felsorolja azokat a beszélgetéseket, amelyekben a robot részt vett egy adott csatornakiszolgálón. A csatornakiszolgáló lapokban adja vissza az eredményeket, és minden lap tartalmaz egy |
| GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken) |
Kérje le a nyers bejelentkezési hivatkozást, amelyet elküldhet a felhasználónak egy kapcsolatnévre való bejelentkezéshez, testreszabott alkalmazás-hitelesítő adatok használatával. |
| GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken) |
Kérje le a nyers bejelentkezési hivatkozást, amelyet elküldhet a felhasználónak egy kapcsolatnévre való bejelentkezéshez, testreszabott alkalmazás-hitelesítő adatok használatával. |
| GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken) |
Kérje le a nyers bejelentkezési hivatkozást, amelyet elküldhet a felhasználónak a kapcsolatnévre való bejelentkezéshez a robot alkalmazás-hitelesítő adataival. |
| GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken) |
Kérje le a nyers bejelentkezési hivatkozást, amelyet elküldhet a felhasználónak a kapcsolatnévre való bejelentkezéshez a robot alkalmazás-hitelesítő adataival. |
| GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken) |
Kérje le a nyers bejelentkezési hivatkozást, amelyet elküldhet a felhasználónak a kapcsolatnévre való bejelentkezéshez. |
| GetSignInResourceAsync(ITurnContext, String, CancellationToken) |
Kérje le a nyers bejelentkezési hivatkozást, amelyet elküldhet a felhasználónak a kapcsolatnévre való bejelentkezéshez. |
| GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken) |
Kérje le a nyers bejelentkezési hivatkozást, amelyet elküldhet a felhasználónak a kapcsolatnévre való bejelentkezéshez. |
| GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Lekéri az adott felhasználóhoz konfigurált összes kapcsolat jogkivonatának állapotát a testreszabott alkalmazás hitelesítő adataival. |
| GetTokenStatusAsync(ITurnContext, String, String, CancellationToken) |
Lekéri az adott felhasználó minden konfigurált kapcsolatának jogkivonat-állapotát a robot Alkalmazás hitelesítő adataival. |
| GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Megkísérli lekérni a bejelentkezési folyamatban lévő felhasználó jogkivonatát a testre szabott alkalmazás-hitelesítő adatok használatával. |
| GetUserTokenAsync(ITurnContext, String, String, CancellationToken) |
Megkísérli lekérni a bejelentkezési folyamatban lévő felhasználó jogkivonatát a robot alkalmazás hitelesítő adataival. |
| ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken) |
Létrehoz egy fordulókörnyezetet, és futtatja a köztesszoftver-folyamatot egy bejövő tevékenységhez. |
| ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken) |
Létrehoz egy fordulókörnyezetet, és futtatja a köztesszoftver-folyamatot egy bejövő tevékenységhez. |
| ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken) |
Kimenő tevékenység küldésére vonatkozó egyéni logika. Az alosztályok felülbírálhatják ezt a metódust és a CanProcessOutgoingActivity metódust, hogy egyéni logikával dolgozzák fel a kimenő tevékenységet. |
| RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken) |
Elindítja a tevékenységfeldolgozást az aktuális robotfordulóhoz. (Öröklődés forrása BotAdapter) |
| SendActivitiesAsync(ITurnContext, Activity[], CancellationToken) |
Tevékenységeket küld a beszélgetésbe. |
| SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Kijelentkezteti a felhasználót a jogkivonat-kiszolgálóval, testreszabott alkalmazás-hitelesítő adatok használatával. |
| SignOutUserAsync(ITurnContext, String, String, CancellationToken) |
Kijelentkezteti a felhasználót a jogkivonat-kiszolgálóval a robot alkalmazás-hitelesítő adataival. |
| UpdateActivityAsync(ITurnContext, Activity, CancellationToken) |
Lecserél egy meglévő tevékenységet a beszélgetésben. |
| Use(IMiddleware) |
Köztes szoftver hozzáadása az adapter folyamatához. |
Explicit interfész-implementációk
| IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken) |
Egy robotadapter, amely csatlakoztathat egy robotot egy szolgáltatásvégponthoz. |
Bővítő metódusok
| UseBotState(BotAdapter, BotState[]) |
Köztes szoftver hozzáadása az adapterhez egy vagy több BotState objektum regisztrálásához a turn környezetben. A köztes szoftver az egyes fordulók elején regisztrálja az állapotobjektumokat a turn környezetében. |
| UseState(BotAdapter, UserState, ConversationState, Boolean) |
Elavult.
Felhasználói és beszélgetési állapotobjektumokat regisztrál az adapterrel. Ezek az objektumok a turn környezet TurnStatekeresztül érhetők el.Get<T>() metódus. |
| UseStorage(BotAdapter, IStorage) |
Köztes szoftvereket ad hozzá az adapterhez, hogy regisztráljon egy IStorage objektumot a turn kontextusban. A köztes szoftver az egyes fordulók elején regisztrálja az állapotobjektumokat a turn környezetében. |