BotFrameworkHttpAdapterBase Classe

Définition

Espace de noms:: Microsoft.Bot.Builder.Streaming

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.

Classe de base d’adaptateur 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

Héritage: Object

BotAdapter

BotFrameworkAdapter
BotFrameworkHttpAdapterBase

Dérivé: Microsoft.Bot.Builder.Integration.AspNet.Core.BotFrameworkHttpAdapter

Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkHttpAdapter

Implémente: IStreamingActivityProcessor IDisposable

Remarques

BotFrameworkAdapter est toujours pris en charge mais l’adaptateur recommandé est CloudAdapter.

Constructeurs

Nom	Description
BotFrameworkHttpAdapterBase(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Initialise une nouvelle instance de la classe BotFrameworkHttpAdapterBase.
BotFrameworkHttpAdapterBase(ICredentialProvider, IChannelProvider, HttpClient, ILogger<BotFrameworkHttpAdapterBase>)	Initialise une nouvelle instance de la classe BotFrameworkHttpAdapterBase.
BotFrameworkHttpAdapterBase(ICredentialProvider, IChannelProvider, ILogger<BotFrameworkHttpAdapterBase>)	Initialise une nouvelle instance de la classe BotFrameworkHttpAdapterBase.

Champs

Nom	Description
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

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.
ConnectedBot	Obtient ou définit le bot connecté à cet adaptateur.
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	Obtient l’enregistreur d’événements 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’erreurs qui peut intercepter des exceptions dans l’intergiciel ou l’application. (Hérité de BotAdapter)
RequestHandlers	Obtient ou définit les gestionnaires de requêtes pour cet adaptateur.

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.
ConnectNamedPipeAsync(String, IBot, String)	Crée un nouveau StreamingRequestHandler pour écouter le canal nommé spécifié et transmettre des demandes à cet adaptateur.
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é. La surcharge reçoit une conversationReference, y compris 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é. La surcharge reçoit une conversationReference, y compris 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 informations d’identification. (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)	Supprime un membre de la conversation actuelle. (Hérité de BotFrameworkAdapter)
Dispose()	Classe de base d’adaptateur HTTP.
Dispose(Boolean)	Dispose des ressources du StreamingRequestHandler.
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 des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée, à l’aide des 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 d’un utilisateur qui se trouve dans un flux de connexion, à l’aide des 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)
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Envoie une activité sortante.
ProcessStreamingActivityAsync(Activity, BotCallbackHandler, CancellationToken)	Méthode d’adaptateur principale pour le traitement des activités envoyées à partir du canal de diffusion en continu. Crée un contexte de tour et exécute le pipeline d’intergiciel pour une activité entrante. Ajoute ArgumentNullException des arguments nuls.
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é.
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 jetons à l’aide des 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)	Classe de base d’adaptateur HTTP. (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. 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 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. L’intergiciel enregistre les objets d’état sur le contexte de tour au début de chaque tour.

S’applique à