Creates a new ActivityPrompt instance.
Unique ID of the dialog within its parent DialogSet or ComponentDialog.
Validator that will be called each time a new activity is received.
Sets the unique ID of the dialog.
Called when a prompt dialog is pushed onto the dialog stack and is being activated.
The DialogContext for the current turn of the conversation.
PromptOptions, additional information to pass to the prompt being started.
A Promise representing the asynchronous operation.
Fluent method for configuring the object.
Configuration settings to apply.
The Configurable after the operation is complete.
Called when a prompt dialog is the active dialog and the user replied with a new activity.
The DialogContext for the current turn of conversation.
A Promise representing the asynchronous operation.
When overridden in a derived class, performs clean up for the dialog before it ends.
The context object for the turn.
Current state information for this dialog.
The reason the dialog is ending.
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.
Gets the converter for the selector configuration. *
The key of the conditional selector configuration. *
The converter for the selector configuration.
An encoded string used to aid in the detection of agent changes on re-deployment.
Unique string which should only change when dialog has changed in a way that should restart the dialog.
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.
ProtectedonCalled when an event has been raised, using DialogContext.emitEvent method , by either the current dialog or a dialog that the current dialog started.
The dialog context for the current turn of conversation.
The event being raised.
True if the event is handled by the current dialog and bubbling should stop.
ProtectedonCalled after an event was bubbled to all parents and wasn't handled.
The dialog context for the current turn of conversation.
The event being raised.
Whether the event is handled by the current dialog and further processing should stop.
ProtectedonCalled before an event is bubbled to its parent.
The dialog context for the current turn of conversation.
The event being raised.
Whether the event is handled by the current dialog and further processing should stop.
ProtectedonWhen overridden in a derived class, prompts the user for input.
TurnContext, context for the current turn of conversation with the user.
Contains state for the current instance of the prompt on the dialog stack.
A PromptOptions object constructed from the options initially provided in the call to Prompt.
A boolean representing if the prompt is a retry.
A Promise representing the asynchronous operation.
ProtectedonWhen overridden in a derived class, attempts to recognize the incoming Activity.
TurnContext, context for the current turn of conversation with the user.
Contains state for the current instance of the prompt on the dialog stack.
A PromptOptions object constructed from the options initially provided in the call to Prompt.
A Promise representing the asynchronous operation.
Called when a prompt dialog has been requested to re-prompt the user for input.
TurnContext, context for the current turn of conversation with the user.
DialogInstance, the instance of the dialog on the stack.
A Promise representing the asynchronous operation.
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.
The DialogContext for the current turn of the conversation.
DialogReason, an enum indicating why the dialog resumed.
Optional_result: anyOptional. Value returned from the previous dialog on the stack. The type of the value returned is dependent on the previous dialog.
A Promise representing the asynchronous operation.
Waits for an activity to be received.
Remarks
This prompt requires a validator be passed in and is useful when waiting for non-message activities like an event to be received. The validator can ignore received events until the expected activity is received.