ActivityHandler.OnCommandActivityAsync 方法

定义

在使用 OnTurnAsync(ITurnContext, CancellationToken) 的基本行为时收到命令活动时调用。 命令是执行作的请求,接收方通常使用一个或多个 commandResult 活动进行响应。 接收方还应显式拒绝不支持的命令活动。

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

参数

turnContext
ITurnContext<ICommandActivity>

本回合的强类型上下文对象。

cancellationToken
CancellationToken

其他对象或线程可以使用的取消令牌来接收取消通知。

返回

表示要执行的工作的任务。

注解

OnTurnAsync(ITurnContext, CancellationToken) 方法收到命令活动时,它将调用此方法。

在派生类中,重写此方法以添加适用于所有 comand 活动的逻辑。 在调用基类 OnCommandActivityAsync(ITurnContext<ICommandActivity>, CancellationToken) 方法之前,在特定的命令处理逻辑之前添加要应用的逻辑。 在调用基类 OnCommandActivityAsync(ITurnContext<ICommandActivity>, CancellationToken) 方法后,添加要应用于特定命令处理逻辑的逻辑。

命令活动将来自客户端或通道的编程信息传达给机器人。 命令活动的意义由 Name 属性定义,该属性在通道范围内具有意义。

适用于

另请参阅