ActionScope Class

Reference

Definition

Namespace:: Microsoft.Bot.Builder.Dialogs.Adaptive.Actions

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

Package:: Microsoft.Bot.Builder.Dialogs.Adaptive v4.18.1

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.

ActionScope manages execution of a block of actions, and supports Goto, Continue and Break semantics..

public class ActionScope : Microsoft.Bot.Builder.Dialogs.Dialog, Microsoft.Bot.Builder.Dialogs.IDialogDependencies

type ActionScope = class
    inherit Dialog
    interface IDialogDependencies

Public Class ActionScope
Inherits Dialog
Implements IDialogDependencies

Inheritance: Object

Dialog
ActionScope

Derived: Microsoft.Bot.Builder.Dialogs.Adaptive.Actions.Case

Microsoft.Bot.Builder.Dialogs.Adaptive.Actions.Foreach

Microsoft.Bot.Builder.Dialogs.Adaptive.Actions.ForeachPage

Implements: IDialogDependencies

Constructors

ActionScope(IEnumerable<Dialog>)

Initializes a new instance of the ActionScope class.

Fields

OFFSETKEY

Defines the path for the offset key.

Properties

Actions	Gets or sets the actions to execute.
Id	Gets or sets id for the dialog. (Inherited from Dialog)
Source	Gets the information of the cref="SourceRange"/>. (Inherited from Dialog)
TelemetryClient	Gets or sets the IBotTelemetryClient to use for logging. (Inherited from Dialog)

Methods

BeginActionAsync(DialogContext, Int32, CancellationToken)	Starts a new dialog and pushes it onto the dialog stack.
BeginDialogAsync(DialogContext, Object, CancellationToken)	Called when the dialog is started and pushed onto the dialog stack.
ContinueDialogAsync(DialogContext, CancellationToken)	Called when the dialog is continued, where it is the active dialog and the user replies with a new activity.
EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)	Called when the dialog is ending. (Inherited from Dialog)
GetDependencies()	Enumerates child dialog dependencies so they can be added to the containers dialog set.
GetVersion()	Gets a unique string which represents the version of this dialog. If the version changes between turns the dialog system will emit a DialogChanged event.
OnActionScopeResultAsync(DialogContext, ActionScopeResult, CancellationToken)	Called when returning control to this dialog with an ActionScopeResult.
OnBreakLoopAsync(DialogContext, ActionScopeResult, CancellationToken)	Called when returning control to this dialog with an ActionScopeResult with the property ActionCommand set to `BreakLoop`.
OnComputeId()	Builds the compute Id for the dialog.
OnContinueLoopAsync(DialogContext, ActionScopeResult, CancellationToken)	Called when returning control to this dialog with an ActionScopeResult with the property ActionCommand set to `ContinueLoop`.
OnDialogEventAsync(DialogContext, DialogEvent, CancellationToken)	Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. (Inherited from Dialog)
OnEndOfActionsAsync(DialogContext, Object, CancellationToken)	Called when the dialog's action ends.
OnGotoActionAsync(DialogContext, ActionScopeResult, CancellationToken)	Called when returning control to this dialog with an ActionScopeResult with the property ActionCommand set to `GoToAction`.
OnNextActionAsync(DialogContext, Object, CancellationToken)	Called when the dialog continues to the next action.
OnPostBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)	Called after an event was bubbled to all parents and wasn't handled. (Inherited from Dialog)
OnPreBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)	Called before an event is bubbled to its parent. (Inherited from Dialog)
RegisterSourceLocation(String, Int32)	Registers a cref="SourceRange"/> in the provided location. (Inherited from Dialog)
RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken)	Called when the dialog should re-prompt the user for input. (Inherited from Dialog)
ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken)	Called when a child dialog completed its turn, returning control to this dialog.

Extension Methods

RunAsync(Dialog, ITurnContext, IStatePropertyAccessor<DialogState>, CancellationToken)

Creates a dialog stack and starts a dialog, pushing it onto the stack.

Applies to

Share via