ActivityHandler.OnCommandActivityAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
の基本動作 OnTurnAsync(ITurnContext, CancellationToken) が使用されたときにコマンド アクティビティを受信したときに呼び出されます。 コマンドはアクションを実行する要求であり、受信者は通常、1 つ以上の 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.TaskProtected Overridable Function OnCommandActivityAsync (turnContext As ITurnContext(Of ICommandActivity), cancellationToken As CancellationToken) As Taskパラメーター
- turnContext
- ITurnContext<ICommandActivity>
このターンの厳密に型指定されたコンテキスト オブジェクト。
- cancellationToken
- CancellationToken
キャンセル通知を受け取るために他のオブジェクトまたはスレッドで使用できるキャンセル トークン。
戻り値
実行するキューに登録された作業を表すタスク。
注釈
メソッドは、 OnTurnAsync(ITurnContext, CancellationToken) コマンド アクティビティを受け取ると、このメソッドを呼び出します。
派生クラスで、このメソッドをオーバーライドして、すべてのコマンド アクティビティに適用されるロジックを追加します。 基底クラス OnCommandActivityAsync(ITurnContext<ICommandActivity>, CancellationToken) メソッドの呼び出しの前に、特定のコマンド処理ロジックの前に適用するロジックを追加します。 基底クラス OnCommandActivityAsync(ITurnContext<ICommandActivity>, CancellationToken) メソッドの呼び出しの後に、特定のコマンド処理ロジックの後に適用するロジックを追加します。
コマンド アクティビティは、クライアントまたはチャネルからボットにプログラム情報を伝えます。 コマンド アクティビティの意味は、 プロパティによって Name 定義されます。これは、チャネルのスコープ内で意味があります。