DateTimeInput Class

Reference

Definition

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

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

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

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.

Input dialog to collect a datetime from the user.

public class DateTimeInput : Microsoft.Bot.Builder.Dialogs.Adaptive.Input.InputDialog

type DateTimeInput = class
    inherit InputDialog

Public Class DateTimeInput
Inherits InputDialog

Inheritance: Object

Dialog

InputDialog
DateTimeInput

Remarks

The value that is output from a DateTimeInput is an array of DateTimeResolutions, or the output of OutputFormat.

Constructors

DateTimeInput(String, Int32)

Initializes a new instance of the DateTimeInput class.

Fields

Kind	Class identifier.
TURN_COUNT_PROPERTY	Defines dialog context turn count property value. (Inherited from InputDialog)
VALUE_PROPERTY	Defines dialog context state property value. (Inherited from InputDialog)

Properties

AllowInterruptions	Gets or sets intteruption policy. (Inherited from InputDialog)
AlwaysPrompt	Gets or sets a value indicating whether the input should always prompt the user regardless of there being a value or not. (Inherited from InputDialog)
DefaultLocale	Gets or sets the DefaultLocale to use to parse confirmation choices if there is not one passed by the caller.
DefaultValue	Gets or sets the default value for the input dialog when MaxTurnCount is exceeded. (Inherited from InputDialog)
DefaultValueResponse	Gets or sets the activity template to send when MaxTurnCount has been reached and the default value is used. (Inherited from InputDialog)
Disabled	Gets or sets whether this action should be disabled. (Inherited from InputDialog)
Id	Gets or sets id for the dialog. (Inherited from Dialog)
InvalidPrompt	Gets or sets the activity template to send to the user whenever the value provided is invalid. (Inherited from InputDialog)
MaxTurnCount	Gets or sets maximum number of times to ask the user for this value before the dialog gives up. (Inherited from InputDialog)
OutputFormat	Gets or sets the expression to use to format the result.
Prompt	Gets or sets the activity to send to the user. (Inherited from InputDialog)
Property	Gets or sets the memory property path which the value will be bound to. (Inherited from InputDialog)
Source	Gets the information of the cref="SourceRange"/>. (Inherited from Dialog)
TelemetryClient	Gets or sets the IBotTelemetryClient to use for logging. (Inherited from Dialog)
UnrecognizedPrompt	Gets or sets the activity template for retrying. (Inherited from InputDialog)
Validations	Gets or sets the expressions to run to validate the input. (Inherited from InputDialog)
Value	Gets or sets a the expression to use to bind input to the dialog. (Inherited from InputDialog)

Methods

AppendChoices(IMessageActivity, String, IList<Choice>, ListStyle, ChoiceFactoryOptions, CancellationToken)	AppendChoices is utility method to build up a message activity given all of the options. (Inherited from InputDialog)
AppendChoices(IMessageActivity, String, IList<Choice>, ListStyle, ChoiceFactoryOptions, String, IList<String>, CancellationToken)	AppendChoices is utility method to build up a message activity given all of the options. (Inherited from InputDialog)
BeginDialogAsync(DialogContext, Object, CancellationToken)	Called when the dialog is started and pushed onto the dialog stack. (Inherited from InputDialog)
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 InputDialog)
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 Dialog)
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)
OnInitializeOptions(DialogContext, Object)	Method which processes options. (Inherited from InputDialog)
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 InputDialog)
OnRecognizeInputAsync(DialogContext, CancellationToken)	Called when input has been received.
OnRenderPromptAsync(DialogContext, InputState, CancellationToken)	Method which renders the prompt to the user give n the current input state. (Inherited from InputDialog)
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 completes its turn, returning control to this dialog. (Inherited from InputDialog)

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