ComponentDialog.ResumeDialogAsync Method
Definition
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 child dialog on the parent's dialog stack completed this turn, returning control to this dialog component.
public override System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult> ResumeDialogAsync (Microsoft.Bot.Builder.Dialogs.DialogContext outerDc, Microsoft.Bot.Builder.Dialogs.DialogReason reason, object result = default, System.Threading.CancellationToken cancellationToken = default);
override this.ResumeDialogAsync : Microsoft.Bot.Builder.Dialogs.DialogContext * Microsoft.Bot.Builder.Dialogs.DialogReason * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult>
Public Overrides Function ResumeDialogAsync (outerDc As DialogContext, reason As DialogReason, Optional result As Object = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DialogTurnResult)
Parameters
- outerDc
- DialogContext
The DialogContext for the current turn of conversation.
- reason
- DialogReason
Reason why the dialog resumed.
- result
- Object
Optional, value returned from the dialog that was called. The type of the value returned is dependent on the child 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 this dialog is still active after this dialog turn has been processed.
Generally, the child dialog was started with a call to BeginDialogAsync(DialogContext, Object, CancellationToken) in the parent's context. However, if the ReplaceDialogAsync(String, Object, CancellationToken) method is called, the logical child dialog may be different than the original.
If this method is *not* overridden, the dialog automatically calls its RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken) when the user replies.