BotFrameworkHttpAdapter Classe

Définition

Espace de noms:: Microsoft.Bot.Builder.Integration.AspNet.WebApi

Assembly:: Microsoft.Bot.Builder.Integration.AspNet.WebApi.dll

Paquet:: Microsoft.Bot.Builder.Integration.AspNet.WebApi 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.

Une implémentation d’adaptateur Bot Builder gérait les requêtes HTTP du Bot Framework.

public class BotFrameworkHttpAdapter : Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase, Microsoft.Bot.Builder.Integration.AspNet.WebApi.IBotFrameworkHttpAdapter

type BotFrameworkHttpAdapter = class
    inherit BotFrameworkHttpAdapterBase
    interface IBotFrameworkHttpAdapter

Public Class BotFrameworkHttpAdapter
Inherits BotFrameworkHttpAdapterBase
Implements IBotFrameworkHttpAdapter

Héritage: Object

BotAdapter

BotFrameworkAdapter

BotFrameworkHttpAdapterBase
BotFrameworkHttpAdapter

Implémente: IBotFrameworkHttpAdapter

Constructeurs

Nom	Description
BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, HttpClient, ILogger<BotFrameworkHttpAdapter>)	Initialise une nouvelle instance de la classe BotFrameworkHttpAdapter.
BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, ILogger<BotFrameworkHttpAdapter>)	Initialise une nouvelle instance de la classe BotFrameworkHttpAdapter.

Champs

Nom	Description
BotIdentityKey	La valeur de la chaîne pour la clé d’identité du bot. (Hérité de BotAdapter)
InvokeResponseKey	La valeur clé pour toute InvokeResponseActivity qui serait sur le TurnState. (Hérité de BotAdapter)
OAuthScopeKey	La valeur de chaîne pour la clé de portée OAuth. (Hérité de BotAdapter)

Propriétés

Nom	Description
AppCredentialMap	Obtient la carte des applications pour AppCredentials cet adaptateur. (Hérité de BotFrameworkAdapter)
ChannelProvider	Obtient le fournisseur de canaux pour cet adaptateur. (Hérité de BotFrameworkAdapter)
ClaimsIdentity	Obtient ou définit l’identité des revendications pour cet adaptateur. (Hérité de BotFrameworkHttpAdapterBase)
ConnectedBot	Obtient ou configure le bot connecté à cet adaptateur. (Hérité de BotFrameworkHttpAdapterBase)
CredentialProvider	Obtient le fournisseur d’informations d’identification pour cet adaptateur. (Hérité de BotFrameworkAdapter)
HttpClient	Il obtient la fonction personnalisée HttpClient pour cet adaptateur si spécifié. (Hérité de BotFrameworkAdapter)
Logger	Il a le logger pour cet adaptateur. (Hérité de BotFrameworkAdapter)
MiddlewareSet	Obtient la collection d’intergiciels dans le pipeline de l’adaptateur. (Hérité de BotAdapter)
OnTurnError	Obtient ou définit un gestionnaire d’erreur capable de détecter les exceptions dans le middleware ou l’application. (Hérité de BotAdapter)
RequestHandlers	Obtient ou définit les gestionnaires de requêtes pour cet adaptateur. (Hérité de BotFrameworkHttpAdapterBase)

Méthodes

Nom	Description
BuildCredentialsAsync(String, String)	Logique pour construire un AppCredentials objet à utiliser pour acquérir des jetons pour ce client Http. (Hérité de BotFrameworkAdapter)
CanProcessOutgoingActivity(Activity)	Évalue si le traitement d’une activité sortante est possible. (Hérité de BotFrameworkHttpAdapterBase)
ConnectNamedPipeAsync(String, IBot, String)	Crée un nouveau StreamingRequestHandler pour écouter le Named Pipe spécifié et transmettre les requêtes à cet adaptateur. (Hérité de BotFrameworkHttpAdapterBase)
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. (Hérité de BotFrameworkAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Envoie un message proactif du bot à une conversation. (Hérité de BotFrameworkAdapter)
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. (Hérité de BotFrameworkAdapter)
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Crée une conversation sur le canal spécifié. (Hérité de BotFrameworkAdapter)
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Obsolète. Crée une conversation sur le canal spécifié. Overload reçoit une ConversationReference incluant le locataire. (Hérité de BotFrameworkAdapter)
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Crée une conversation sur le canal spécifié. (Hérité de BotFrameworkAdapter)
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Obsolète. Crée une conversation sur le canal spécifié. Overload reçoit une ConversationReference incluant le locataire. (Hérité de BotFrameworkAdapter)
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Crée une conversation sur le canal spécifié. (Hérité de BotAdapter)
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	Crée un client OAuth pour le bot avec les identifiants. (Hérité de BotFrameworkAdapter)
CreateOAuthApiClientAsync(ITurnContext)	Crée un client OAuth pour le bot. (Hérité de BotFrameworkAdapter)
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Supprime une activité existante dans la conversation. (Hérité de BotFrameworkAdapter)
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	Élimine un membre de la conversation en cours. (Hérité de BotFrameworkAdapter)
Dispose()	Une implémentation d’adaptateur Bot Builder gérait les requêtes HTTP du Bot Framework. (Hérité de BotFrameworkHttpAdapterBase)
Dispose(Boolean)	Dispose des ressources du StreamingRequestHandler. (Hérité de BotFrameworkHttpAdapterBase)
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	Effectue une opération d’échange de jetons telle que pour l’authentification unique. (Hérité de BotFrameworkAdapter)
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	Effectue une opération d’échange de jetons telle que pour l’authentification unique. (Hérité de BotFrameworkAdapter)
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. (Hérité de BotFrameworkAdapter)
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	Récupère les jetons Azure Active Directory pour des ressources particulières sur une connexion configurée, en utilisant les AppCredentials du bot. (Hérité de BotFrameworkAdapter)
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	Répertorie les membres d’une activité donnée. (Hérité de BotFrameworkAdapter)
GetConversationMembersAsync(ITurnContext, CancellationToken)	Répertorie les membres de la conversation actuelle. (Hérité de BotFrameworkAdapter)
GetConversationsAsync(ITurnContext, String, CancellationToken)	Répertorie les conversations dans lesquelles ce bot a participé pour un serveur de canal donné. Le serveur de canal renvoie les résultats sous forme de pages et chaque page inclura un `continuationToken` qui peut être utilisé pour récupérer la page suivante de résultats depuis le serveur. (Hérité de BotFrameworkAdapter)
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 renvoie les résultats sous forme de pages et chaque page inclura un `continuationToken` qui peut être utilisé pour récupérer la page suivante de résultats depuis le serveur. (Hérité de BotFrameworkAdapter)
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. (Hérité de BotFrameworkAdapter)
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. (Hérité de BotFrameworkAdapter)
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. (Hérité de BotFrameworkAdapter)
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. (Hérité de BotFrameworkAdapter)
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion. (Hérité de BotFrameworkAdapter)
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion. (Hérité de BotFrameworkAdapter)
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)	Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion. (Hérité de BotFrameworkAdapter)
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. (Hérité de BotFrameworkAdapter)
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. (Hérité de BotFrameworkAdapter)
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. (Hérité de BotFrameworkAdapter)
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	Tente de récupérer le jeton pour un utilisateur qui est dans un flux de connexion, en utilisant les AppCredentials du bot. (Hérité de BotFrameworkAdapter)
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Crée un contexte de tour et exécute le pipeline d’intergiciel pour une activité entrante. (Hérité de BotFrameworkAdapter)
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	Crée un contexte de tour et exécute le pipeline d’intergiciel pour une activité entrante. (Hérité de BotFrameworkAdapter)
ProcessAsync(HttpRequestMessage, HttpResponseMessage, IBot, CancellationToken)	Cette méthode peut être appelée depuis l’intérieur d’une méthode POST sur n’importe quelle implémentation de contrôleur.
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Envoie une activité sortante. (Hérité de BotFrameworkHttpAdapterBase)
ProcessStreamingActivityAsync(Activity, BotCallbackHandler, CancellationToken)	Méthode d’adaptateur primaire pour traiter les activités envoyées depuis le canal de streaming. Crée un contexte de tour et exécute le pipeline d’intergiciel pour une activité entrante. Ajoute ArgumentNullException des arguments nuls. (Hérité de BotFrameworkHttpAdapterBase)
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. (Hérité de BotFrameworkAdapter)
SendStreamingActivityAsync(Activity, CancellationToken)	Envoie une activité. (Hérité de BotFrameworkHttpAdapterBase)
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Déconnecte l’utilisateur avec le serveur de jetons à l’aide d’AppCredentials personnalisés. (Hérité de BotFrameworkAdapter)
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Déconnecte l’utilisateur avec le serveur de jeton, en utilisant les AppCredentials du bot. (Hérité de BotFrameworkAdapter)
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Remplace une activité existante dans la conversation. (Hérité de BotFrameworkAdapter)
Use(IMiddleware)	Ajoute un intergiciel au pipeline de l’adaptateur. (Hérité de BotFrameworkAdapter)

Implémentations d’interfaces explicites

Nom	Description
IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)	Une implémentation d’adaptateur Bot Builder gérait les requêtes HTTP du Bot Framework. (Hérité de BotFrameworkAdapter)

Méthodes d’extension

Nom	Description
UseBotState(BotAdapter, BotState[])	Ajoute un middleware à l’adaptateur pour enregistrer un ou plusieurs BotState objets dans le contexte du tour. Le middleware enregistre les objets d’état dans le contexte du tour au début de chaque tour.
UseState(BotAdapter, UserState, ConversationState, Boolean)	Obsolète. Enregistre les objets d’état utilisateur et de conversation avec l’adaptateur. Ces objets seront disponibles via la méthode .TurnState du Get<T>()contexte de tournage.
UseStorage(BotAdapter, IStorage)	Ajoute un middleware à l’adaptateur pour enregistrer un IStorage objet dans le contexte du tour. Le middleware enregistre les objets d’état dans le contexte du tour au début de chaque tour.

S’applique à