Prompt<T>.BeginDialogAsync Method

Reference

Definition

Namespace:: Microsoft.Bot.Builder.Dialogs

Assembly:: Microsoft.Bot.Builder.Dialogs.dll

Package:: Microsoft.Bot.Builder.Dialogs v4.22.7

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Called when a prompt dialog is pushed onto the dialog stack and is being activated.

public override System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult> BeginDialogAsync (Microsoft.Bot.Builder.Dialogs.DialogContext dc, object options, System.Threading.CancellationToken cancellationToken = default);

override this.BeginDialogAsync : Microsoft.Bot.Builder.Dialogs.DialogContext * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult>

Public Overrides Function BeginDialogAsync (dc As DialogContext, options As Object, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DialogTurnResult)

Parameters

dc: DialogContext

The dialog context for the current turn of the conversation.

options: Object

Optional, additional information to pass to the prompt being started.

cancellationToken: CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DialogTurnResult>

A Task representing the asynchronous operation.

Remarks

If the task is successful, the result indicates whether the prompt is still active after the turn has been processed by the prompt.

Applies to

Jaa