Ask 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.

Ask for an open-ended response.

public class Ask : Microsoft.Bot.Builder.Dialogs.Adaptive.Actions.SendActivity

type Ask = class
    inherit SendActivity

Public Class Ask
Inherits SendActivity

Inheritance: Object

Dialog

SendActivity
Ask

Remarks

This sends an activity and then terminates the turn with CompleteAndWait. The next activity from the user will then be handled by the parent adaptive dialog.

It also builds in a model of the properties that are expected in response through ExpectedProperties. Retries is updated as the same question is asked multiple times.

Constructors

Ask(String, ArrayExpression<String>, String, Int32)

Initializes a new instance of the Ask class.

Fields

Kind	Class identifier.

Properties

Activity	Gets or sets template for the activity. (Inherited from SendActivity)
DefaultOperation	Gets or sets the default operation that will be used when no operation is recognized.
Disabled	Gets or sets an optional expression which if is true will disable this action. (Inherited from SendActivity)
ExpectedProperties	Gets or sets properties expected to be filled by response.
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

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. (Inherited from Dialog)
EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)	Called when the dialog is ending. (Inherited from Dialog)
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. (Inherited from Dialog)
OnComputeId()	Builds the compute Id for the dialog. (Inherited from SendActivity)
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)
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 this turn, returning control to this dialog. (Inherited from Dialog)

Extension Methods

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

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

Applies to