BotFrameworkAdapter Classe

Référence

Définition

Espace de noms:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Paquet:: Microsoft.Bot.Builder v4.22.7

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Adaptateur de bot qui peut connecter un bot à un point de terminaison de service.

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

Héritage: Object

BotAdapter
BotFrameworkAdapter

Dérivé: Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase

Implémente: IExtendedUserTokenProvider IAdapterIntegration IUserTokenProvider IConnectorClientBuilder

Remarques

BotFrameworkAdapter est toujours pris en charge, mais l’adaptateur recommandé est « CloudAdapter ». L’adaptateur de bot encapsule les processus d’authentification et envoie des activités vers et reçoit des activités du service Bot Connector. Lorsque votre bot reçoit une activité, l’adaptateur crée un objet de contexte, le transmet à la logique d’application de votre bot et renvoie des réponses au canal de l’utilisateur.

Utilisez Use(IMiddleware) pour ajouter des objets IMiddleware à la collection d’intergiciels de votre adaptateur. L’adaptateur traite et dirige les activités entrantes via le pipeline d’intergiciel de bot vers la logique de votre bot, puis revient à nouveau. À mesure que chaque activité circule dans et hors du bot, chaque élément d’intergiciel peut inspecter ou agir sur l’activité, avant et après l’exécution de la logique du bot.

Constructeurs

BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Initialise une nouvelle instance de la classe BotFrameworkAdapter à l’aide d’un fournisseur d’informations d’identification.
BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Initialise une nouvelle instance de la classe BotFrameworkAdapter à l’aide d’un fournisseur d’informations d’identification.
BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Initialise une nouvelle instance de la classe BotFrameworkAdapter à l’aide d’un fournisseur d’informations d’identification.

Champs

BotIdentityKey	Valeur de chaîne de la clé d’identité du bot. (Hérité de BotAdapter)
InvokeResponseKey	Valeur de clé de n’importe quel InvokeResponseActivity qui se trouverait sur TurnState. (Hérité de BotAdapter)
OAuthScopeKey	Valeur de chaîne pour la clé d’étendue OAuth. (Hérité de BotAdapter)

Propriétés

AppCredentialMap	Obtient la carte des applications à AppCredentials pour cet adaptateur.
ChannelProvider	Obtient le fournisseur de canaux pour cet adaptateur.
CredentialProvider	Obtient le fournisseur d’informations d’identification pour cet adaptateur.
HttpClient	Obtient la HttpClient personnalisée pour cet adaptateur si elle est spécifiée.
Logger	Obtient l’enregistreur d’événements pour cet adaptateur.
MiddlewareSet	Obtient la collection d’intergiciels dans le pipeline de l’adaptateur. (Hérité de BotAdapter)
OnTurnError	Obtient ou définit un gestionnaire d’erreurs qui peut intercepter des exceptions dans l’intergiciel ou l’application. (Hérité de BotAdapter)

Méthodes

BuildCredentialsAsync(String, String)	Logique permettant de générer un objet AppCredentials à utiliser pour acquérir des jetons pour ce HttpClient.
CanProcessOutgoingActivity(Activity)	Possibilité pour les sous-classes de choisir de traiter une activité sortante.
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Envoie un message proactif à une conversation. (Hérité de BotAdapter)
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	Envoie un message proactif à une conversation. (Hérité de BotAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	Envoie un message proactif du bot à une conversation.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Envoie un message proactif du bot à une conversation.
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	Envoie un message proactif à une conversation. (Hérité de BotAdapter)
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	Envoie un message proactif du bot à une conversation.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Crée une conversation sur le canal spécifié.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Obsolète. Crée une conversation sur le canal spécifié. La surcharge reçoit une conversationReference, y compris le locataire.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Crée une conversation sur le canal spécifié.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Obsolète. Crée une conversation sur le canal spécifié. La surcharge reçoit une conversationReference, y compris le locataire.
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Crée une conversation sur le canal spécifié. (Hérité de BotAdapter)
CreateOAuthApiClientAsync(ITurnContext)	Crée un client OAuth pour le bot.
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	Crée un client OAuth pour le bot avec les informations d’identification.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Supprime une activité existante dans la conversation.
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	Supprime un membre de la conversation actuelle.
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	Effectue une opération d’échange de jetons telle que pour l’authentification unique.
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	Effectue une opération d’échange de jetons telle que pour l’authentification unique.
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)	Récupère des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée, à l’aide d’AppCredentials personnalisés.
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	Récupère des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée, à l’aide des AppCredentials du bot.
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	Répertorie les membres d’une activité donnée.
GetConversationMembersAsync(ITurnContext, CancellationToken)	Répertorie les membres de la conversation actuelle.
GetConversationsAsync(ITurnContext, String, CancellationToken)	Répertorie les conversations dans lesquelles ce bot a participé pour un serveur de canal donné. Le serveur de canal retourne les résultats dans les pages et chaque page inclut un `continuationToken` qui peut être utilisé pour extraire la page suivante des résultats à partir du serveur.
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken)	Répertorie les conversations dans lesquelles ce bot a participé pour un serveur de canal donné. Le serveur de canal retourne les résultats dans les pages et chaque page inclut un `continuationToken` qui peut être utilisé pour extraire la page suivante des résultats à partir du serveur.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion, à l’aide d’AppCredentials personnalisés.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion, à l’aide d’AppCredentials personnalisés.
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion, à l’aide de l’AppCredentials du bot.
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion, à l’aide de l’AppCredentials du bot.
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)	Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné, à l’aide d’AppCredentials personnalisés.
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné, à l’aide des AppCredentials du bot.
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Tente de récupérer le jeton d’un utilisateur qui se trouve dans un flux de connexion à l’aide d’AppCredentials personnalisés.
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	Tente de récupérer le jeton d’un utilisateur qui se trouve dans un flux de connexion, à l’aide des AppCredentials du bot.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Crée un contexte de tour et exécute le pipeline d’intergiciel pour une activité entrante.
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	Crée un contexte de tour et exécute le pipeline d’intergiciel pour une activité entrante.
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Logique personnalisée pour envoyer une activité sortante. Les sous-classes peuvent remplacer cette méthode avec CanProcessOutgoingActivity pour avoir une logique personnalisée pour traiter l’activité sortante.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Démarre le traitement de l’activité pour le tour actuel du bot. (Hérité de BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	Envoie des activités à la conversation.
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Déconnecte l’utilisateur avec le serveur de jetons à l’aide d’AppCredentials personnalisés.
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Déconnecte l’utilisateur avec le serveur de jetons à l’aide des AppCredentials du bot.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Remplace une activité existante dans la conversation.
Use(IMiddleware)	Ajoute un intergiciel au pipeline de l’adaptateur.

Implémentations d’interfaces explicites

IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)

Adaptateur de bot qui peut connecter un bot à un point de terminaison de service.

Méthodes d’extension

UseBotState(BotAdapter, BotState[])	Ajoute un intergiciel à l’adaptateur pour inscrire un ou plusieurs objets BotState sur le contexte de tour. L’intergiciel enregistre les objets d’état sur le contexte de tour au début de chaque tour.
UseState(BotAdapter, UserState, ConversationState, Boolean)	Obsolète. Inscrit des objets d’état utilisateur et de conversation auprès de l’adaptateur. Ces objets seront disponibles via la TurnStatedu contexte de tour. méthodeGet<T>().
UseStorage(BotAdapter, IStorage)	Ajoute un intergiciel à l’adaptateur pour inscrire un objet IStorage sur le contexte de tour. L’intergiciel enregistre les objets d’état sur le contexte de tour au début de chaque tour.

S’applique à

Partager via