ActivityHandler.OnCommandActivityAsync Méthode

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.

Appelé lorsqu’une activité de commande est reçue lorsque le comportement de base de OnTurnAsync(ITurnContext, CancellationToken) est utilisé. Les commandes sont des demandes d’exécution d’une action et de récepteurs qui répondent généralement avec une ou plusieurs activités commandResult. Les récepteurs sont également censés rejeter explicitement les activités de commande non prises en charge.

protected virtual System.Threading.Tasks.Task OnCommandActivityAsync(Microsoft.Bot.Builder.ITurnContext<Microsoft.Bot.Schema.ICommandActivity> turnContext, System.Threading.CancellationToken cancellationToken);

abstract member OnCommandActivityAsync : Microsoft.Bot.Builder.ITurnContext<Microsoft.Bot.Schema.ICommandActivity> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.OnCommandActivityAsync : Microsoft.Bot.Builder.ITurnContext<Microsoft.Bot.Schema.ICommandActivity> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Protected Overridable Function OnCommandActivityAsync (turnContext As ITurnContext(Of ICommandActivity), cancellationToken As CancellationToken) As Task

Paramètres

turnContext: ITurnContext<ICommandActivity>

Un objet contextuel fortement typé pour ce tour.

cancellationToken: CancellationToken

Jeton d’annulation qui peut être utilisé par d’autres objets ou threads pour recevoir une notification d’annulation.

Retours

Task

Tâche qui représente le travail mis en file d’attente à exécuter.

Remarques

Lorsque la méthode OnTurnAsync(ITurnContext, CancellationToken) reçoit une activité de commande, elle appelle cette méthode.

Dans une classe dérivée, substituez cette méthode pour ajouter une logique qui s’applique à toutes les activités comand. Ajoutez une logique à appliquer avant la logique de gestion des commandes spécifique avant l’appel à la classe de base OnCommandActivityAsync(ITurnContext<ICommandActivity>, CancellationToken) méthode. Ajoutez une logique à appliquer après la logique de gestion des commandes spécifique après l’appel à la classe de base OnCommandActivityAsync(ITurnContext<ICommandActivity>, CancellationToken) méthode.

Les activités de commande communiquent des informations programmatiques d’un client ou d’un canal à un bot. La signification d’une activité de commande est définie par la Name propriété, qui a un sens dans le cadre d’un canal.

S’applique à