BotAdapter Classe

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.

Représente un adaptateur de bot qui peut connecter un bot à un point de terminaison de service. Cette classe est abstraite.

public abstract class BotAdapter

type BotAdapter = class

Public MustInherit Class BotAdapter

Héritage: Object
BotAdapter

Dérivé: Microsoft.Bot.Builder.Adapters.Facebook.FacebookAdapter

Microsoft.Bot.Builder.Adapters.Slack.SlackAdapter

Microsoft.Bot.Builder.Adapters.TestAdapter

Microsoft.Bot.Builder.Adapters.Twilio.TwilioAdapter

Microsoft.Bot.Builder.Adapters.Webex.WebexAdapter

Plus…

Remarques

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.

À utiliser Use(IMiddleware) pour ajouter IMiddleware des objets à la collection de middleware de votre adaptateur. L’adaptateur traite et dirige les activités entrantes via le pipeline middleware du bot vers la logique de votre bot, puis revient vers la sortie. Comme chaque activité entre et sort du bot, chaque middleware peut effectuer une inspection ou une action sur l’activité, avant comme après l’exécution de la logique de bot.

Constructeurs

Nom	Description
BotAdapter()	Initialise une nouvelle instance de la classe BotAdapter.

Champs

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

Propriétés

Nom	Description
MiddlewareSet	Obtient la collection d’intergiciels dans le pipeline de l’adaptateur.
OnTurnError	Obtient ou définit un gestionnaire d’erreur capable de détecter les exceptions dans le middleware ou l’application.

Méthodes

Nom	Description
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Envoie un message proactif à une conversation.
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	Envoie un message proactif à une conversation.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	Envoie un message proactif à une conversation.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Envoie un message proactif à une conversation.
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	Envoie un message proactif à une conversation.
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	Envoie un message proactif à une conversation.
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Crée une conversation sur le canal spécifié.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	En cas de substitution dans une classe dérivée, supprime une activité existante dans la conversation.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Crée un contexte de tour et exécute le pipeline middleware pour une activité TRUSTED entrante.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Démarre le traitement de l’activité pour le tour actuel du bot.
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	En cas de substitution dans une classe dérivée, envoie des activités à la conversation.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	En cas de substitution dans une classe dérivée, remplace une activité existante dans la conversation.
Use(IMiddleware)	Ajoute un intergiciel au pipeline de l’adaptateur.

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 à