Share via

ForeachPage.OnBreakLoopAsync Method

  • Reference

Definition

Namespace:
Microsoft.Bot.Builder.Dialogs.Adaptive.Actions
Assembly:
Microsoft.Bot.Builder.Dialogs.Adaptive.dll
Package:
Microsoft.Bot.Builder.Dialogs.Adaptive v4.22.7

Called when a returning control to this dialog with an ActionScopeResult with the property ActionCommand set to BreakLoop.

protected override System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult> OnBreakLoopAsync (Microsoft.Bot.Builder.Dialogs.DialogContext dc, Microsoft.Bot.Builder.Dialogs.Adaptive.Actions.ActionScopeResult actionScopeResult, System.Threading.CancellationToken cancellationToken = default);
override this.OnBreakLoopAsync : Microsoft.Bot.Builder.Dialogs.DialogContext * Microsoft.Bot.Builder.Dialogs.Adaptive.Actions.ActionScopeResult * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult>
Protected Overrides Function OnBreakLoopAsync (dc As DialogContext, actionScopeResult As ActionScopeResult, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DialogTurnResult)

Parameters

dc
DialogContext

The dialog context for the current turn of the conversation.

actionScopeResult
ActionScopeResult

Contains the actions scope result.

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.

Applies to