Share via


ComponentDialog.BeginDialogAsync Method

Definition

Called when the dialog is started and pushed onto the parent's dialog stack.

public override System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult> BeginDialogAsync (Microsoft.Bot.Builder.Dialogs.DialogContext outerDc, object options = default, 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 (outerDc As DialogContext, Optional options As Object = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DialogTurnResult)

Parameters

outerDc
DialogContext

The parent DialogContext for the current turn of conversation.

options
Object

Optional, initial information to pass to the dialog.

cancellationToken
CancellationToken

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

Returns

A Task representing the asynchronous operation.

Remarks

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

Applies to

See also