Class NumberPrompt

Prompts a user to enter a number.

Remarks

By default the prompt will return to the calling dialog a number representing the users input.

Hierarchy (View Summary)

Prompt<number>
- NumberPrompt

Index

Constructors

constructor

Properties

defaultLocale? EndOfTurn

Accessors

Methods

appendChoices beginDialog configure continueDialog endDialog getConverter getVersion onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent onPrompt onRecognize repromptDialog resumeDialog

Constructors

constructor

new NumberPrompt(
    dialogId: string,
    validator?: PromptValidator<number>,
    defaultLocale?: string,
): NumberPrompt
Creates a new NumberPrompt instance.
Parameters
- dialogId: string
  Unique ID of the dialog within its parent DialogSet or ComponentDialog.
- Optionalvalidator: PromptValidator<number>
  (Optional) validator that will be called each time the user responds to the prompt.
- OptionaldefaultLocale: string
  (Optional) locale to use if the TurnContext.activity.locale is not specified. Defaults to a value of en-us.
Returns NumberPrompt
Overrides Prompt.constructor
- Defined in packages/agents-hosting-dialogs/src/prompts/numberPrompt.ts:36

Properties

`Optional`defaultLocale

defaultLocale?: string

The prompts default locale that should be recognized.

`Static`EndOfTurn

EndOfTurn: DialogTurnResult = ...

Gets a default end-of-turn result.

Remarks

This result indicates that a dialog (or a logical step within a dialog) has completed processing for the current turn, is still active, and is waiting for more input.

Accessors

id

get id(): string
Unique ID of the dialog.

Returns string
The Id for the dialog.

Remarks
This will be automatically generated if not specified.
Inherited from Prompt.id
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:49
set id(value: string): void
Sets the unique ID of the dialog.
Parameters
- value: string
Returns void
Inherited from Prompt.id
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:59

Methods

`Protected`appendChoices

appendChoices(
    prompt: string | Activity,
    channelId: string,
    choices: (string | Choice)[],
    style: ListStyle,
    options?: ChoiceFactoryOptions,
    conversationType?: string,
): Activity
Helper function to compose an output activity containing a set of choices.
Parameters
- prompt: string | Activity
  The prompt to append the users choices to.
- channelId: string
  ID of the channel the prompt is being sent to.
- choices: (string | Choice)[]
  List of choices to append.
- style: ListStyle
  Configured style for the list of choices.
- Optionaloptions: ChoiceFactoryOptions
  (Optional) options to configure the underlying ChoiceFactory call.
- OptionalconversationType: string
  (Optional) the type of the conversation.
Returns Activity
The composed activity ready to send to the user.
Inherited from Prompt.appendChoices
- Defined in packages/agents-hosting-dialogs/src/prompts/prompt.ts:407

beginDialog

beginDialog(
dialogContext: DialogContext,
options: PromptOptions,
): Promise<DialogTurnResult<any>>
Called when a prompt dialog is pushed onto the dialog stack and is being activated.
Parameters
- dialogContext: DialogContext
  The DialogContext for the current turn of the conversation.
- options: PromptOptions
  Optional. PromptOptions, additional information to pass to the prompt being started.
Returns Promise<DialogTurnResult<any>>
A Promise representing the asynchronous operation.

Remarks
If the task is successful, the result indicates whether the prompt is still active after the turn has been processed by the prompt.
Inherited from Prompt.beginDialog
- Defined in packages/agents-hosting-dialogs/src/prompts/prompt.ts:213

configure

configure(config: Record<string, unknown>): this
Fluent method for configuring the object.
Parameters
- config: Record<string, unknown>
  Configuration settings to apply.
Returns this
The Configurable after the operation is complete.
Inherited from Prompt.configure
- Defined in packages/agents-hosting-dialogs/src/configurable.ts:18

continueDialog

continueDialog(dialogContext: DialogContext): Promise<DialogTurnResult<any>>
Called when a prompt dialog is the active dialog and the user replied with a new activity.
Parameters
- dialogContext: DialogContext
  The DialogContext for the current turn of conversation.
Returns Promise<DialogTurnResult<any>>
A Promise representing the asynchronous operation.

Remarks
If the task is successful, the result indicates whether the dialog is still active after the turn has been processed by the dialog. The prompt generally continues to receive the user's replies until it accepts the user's reply as valid input for the prompt.
Inherited from Prompt.continueDialog
- Defined in packages/agents-hosting-dialogs/src/prompts/prompt.ts:247

endDialog

endDialog(
    _context: TurnContext,
    _instance: DialogInstance,
    _reason: DialogReason,
): Promise<void>
When overridden in a derived class, performs clean up for the dialog before it ends.
Parameters
- _context: TurnContext
  The context object for the turn.
- _instance: DialogInstance
  Current state information for this dialog.
- _reason: DialogReason
  The reason the dialog is ending.
Returns Promise<void>
Remarks
Derived dialogs that need to perform logging or cleanup before ending should override this method. By default, this method has no effect.

The DialogContext calls this method when the current dialog is ending.
Inherited from Prompt.endDialog
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:181

getConverter

getConverter(_property: string): Converter<unknown, unknown> | ConverterFactory
Gets the converter for the selector configuration. *
Parameters
- _property: string
  The key of the conditional selector configuration. *
Returns Converter<unknown, unknown> | ConverterFactory
The converter for the selector configuration.
Inherited from Prompt.getConverter
- Defined in packages/agents-hosting-dialogs/src/configurable.ts:53

getVersion

getVersion(): string
An encoded string used to aid in the detection of agent changes on re-deployment.

Returns string
Unique string which should only change when dialog has changed in a way that should restart the dialog.

Remarks
This defaults to returning the dialog's id but can be overridden to provide more precise change detection logic. Any dialog on the stack that has its version change will result in a versionChanged event will be raised. If this event is not handled by the agent, an error will be thrown resulting in the agent error handler logic being run.

Returning an empty string will disable version tracking for the component all together.
Inherited from Prompt.getVersion
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:77

`Protected`onComputeId

onComputeId(): string
Called when a unique ID needs to be computed for a dialog.

Returns string
Remarks
SHOULD be overridden to provide a more contextually relevant ID. The preferred pattern for ID's is <dialog type>(this.hashedLabel('<dialog args>')).
Inherited from Prompt.onComputeId
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:248

onDialogEvent

onDialogEvent(
dialogContext: DialogContext,
event: DialogEvent,
): Promise<boolean>
Called when an event has been raised, using DialogContext.emitEvent method , by either the current dialog or a dialog that the current dialog started.
Parameters
- dialogContext: DialogContext
  The dialog context for the current turn of conversation.
- event: DialogEvent
  The event being raised.
Returns Promise<boolean>
True if the event is handled by the current dialog and bubbling should stop.
Inherited from Prompt.onDialogEvent
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:193

`Protected`onPostBubbleEvent

onPostBubbleEvent(_dc: DialogContext, _e: DialogEvent): Promise<boolean>
Called after an event was bubbled to all parents and wasn't handled.
Parameters
- _dc: DialogContext
  The dialog context for the current turn of conversation.
- _e: DialogEvent
  The event being raised.
Returns Promise<boolean>
Whether the event is handled by the current dialog and further processing should stop.

Remarks
This is a good place to perform default processing logic for an event. Returning true will prevent any processing of the event by child dialogs.
Inherited from Prompt.onPostBubbleEvent
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:237

`Protected`onPreBubbleEvent

onPreBubbleEvent(
dialogContext: DialogContext,
event: DialogEvent,
): Promise<boolean>
Called before an event is bubbled to its parent.
Parameters
- dialogContext: DialogContext
  The DialogContext for the current turn of conversation.
- event: DialogEvent
  DialogEvent, the event being raised.
Returns Promise<boolean>
Whether the event is handled by the current dialog and further processing should stop.

Remarks
This is a good place to perform interception of an event as returning true will prevent any further bubbling of the event to the dialogs parents and will also prevent any child dialogs from performing their default processing.
Inherited from Prompt.onPreBubbleEvent
- Defined in packages/agents-hosting-dialogs/src/prompts/prompt.ts:309

`Protected`onPrompt

onPrompt(
    context: TurnContext,
    state: unknown,
    options: PromptOptions,
    isRetry: boolean,
): Promise<void>
Prompts the user for input.
Parameters
- context: TurnContext
  TurnContext context for the current turn of conversation with the user.
- state: unknown
  Contains state for the current instance of the prompt on the dialog stack.
- options: PromptOptions
  A PromptOptions object constructed from the options initially provided in the call to Prompt.
- isRetry: boolean
  true if this is the first time this prompt dialog instance on the stack is prompting the user for input; otherwise, false.
Returns Promise<void>
A Promise representing the asynchronous operation.
Overrides Prompt.onPrompt
- Defined in packages/agents-hosting-dialogs/src/prompts/numberPrompt.ts:53

`Protected`onRecognize

onRecognize(
    context: TurnContext,
    _state: unknown,
    _options: PromptOptions,
): Promise<PromptRecognizerResult<number>>
Attempts to recognize the user's input.
Parameters
- context: TurnContext
  TurnContext, context for the current turn of conversation with the user.
- _state: unknown
  Contains state for the current instance of the prompt on the dialog stack.
- _options: PromptOptions
  A PromptOptions object constructed from the options initially provided in the call to Prompt.
Returns Promise<PromptRecognizerResult<number>>
A Promise representing the asynchronous operation.
Overrides Prompt.onRecognize
- Defined in packages/agents-hosting-dialogs/src/prompts/numberPrompt.ts:76

repromptDialog

repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>
Called when a prompt dialog has been requested to re-prompt the user for input.
Parameters
- context: TurnContext
  TurnContext, context for the current turn of conversation with the user.
- instance: DialogInstance
  DialogInstance, the instance of the dialog on the stack.
Returns Promise<void>
A Promise representing the asynchronous operation.
Inherited from Prompt.repromptDialog
- Defined in packages/agents-hosting-dialogs/src/prompts/prompt.ts:359

resumeDialog

resumeDialog(
    dialogContext: DialogContext,
    _reason: DialogReason,
    _result?: any,
): Promise<DialogTurnResult<any>>
Called when a prompt dialog resumes being the active dialog on the dialog stack, such as when the previous active dialog on the stack completes.
Parameters
- dialogContext: DialogContext
  The DialogContext for the current turn of the conversation.
- _reason: DialogReason
  An enum indicating why the dialog resumed.
- Optional_result: any
  Optional, value returned from the previous dialog on the stack. The type of the value returned is dependent on the previous dialog.
Returns Promise<DialogTurnResult<any>>
A Promise representing the asynchronous operation.

Remarks
If the task is successful, the result indicates whether the dialog is still active after the turn has been processed by the dialog.
Inherited from Prompt.resumeDialog
- Defined in packages/agents-hosting-dialogs/src/prompts/prompt.ts:339

Class NumberPrompt

Remarks

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NumberPrompt

Properties

OptionaldefaultLocale

StaticEndOfTurn

Remarks

Accessors

id

Returns string

Remarks

Parameters

Returns void

Methods

ProtectedappendChoices

Parameters

Returns Activity

beginDialog

Parameters

Returns Promise<DialogTurnResult<any>>

Remarks

configure

Parameters

Returns this

continueDialog

Parameters

Returns Promise<DialogTurnResult<any>>

Remarks

endDialog

Parameters

Returns Promise<void>

Remarks

getConverter

Parameters

Returns Converter<unknown, unknown> | ConverterFactory

getVersion

Returns string

Remarks

ProtectedonComputeId

Returns string

Remarks

onDialogEvent

Parameters

Returns Promise<boolean>

ProtectedonPostBubbleEvent

Parameters

Returns Promise<boolean>

Remarks

ProtectedonPreBubbleEvent

Parameters

Returns Promise<boolean>

Remarks

ProtectedonPrompt

Parameters

Returns Promise<void>

ProtectedonRecognize

Parameters

Returns Promise<PromptRecognizerResult<number>>

repromptDialog

Parameters

Returns Promise<void>

resumeDialog

Parameters

Returns Promise<DialogTurnResult<any>>

Remarks

Settings

On This Page

`Optional`defaultLocale

`Static`EndOfTurn

`Protected`appendChoices

`Protected`onComputeId

`Protected`onPostBubbleEvent

`Protected`onPreBubbleEvent

`Protected`onPrompt

`Protected`onRecognize