IPromptChoiceOptions interface

Package:

botbuilder

Options passed to Prompts.choice() or in a session.beginDialog() call to a custom prompt based on the PromptChoice class.

Extends

IPromptOptions

Properties

attachmentLayout	Hint for how clients should layout multiple attachments. The default value is 'list'.
attachments	For incoming messages contains attachments like images sent from the user. For outgoing messages contains objects like cards or images to send to the user.
choices	(Optional) List of choices to present to the user. If omitted a PromptChoice.onChoices() handler should be provided.
entities	Structured objects passed to the bot or user.
inputHint	Hint for clients letting them know if the bot is expecting further input or not. The built-in prompts will automatically populate this value for outgoing messages.
libraryNamespace	(Optional) namespace to use for localization and other purposes. This defaults to the callers namespace.
listStyle	(Optional) type of list to render for PromptType.choice. Default value is ListStyle.auto.
localizationNamespace	DEPRECATED use libraryNamespace instead.
maxRetries	(Optional) maximum number of times to re-prompt the user. By default the user will be re-prompted indefinitely.
prompt	(Optional) Initial prompt to send the user. This is typically populated by the Prompts.xxx() function.
promptAfterAction	(Optional) flag used to control the re-prompting of a user after a dialog started by an action ends. The default value is true.
refDate	(Optional) reference date when recognizing times. Date expressed in ticks using Date.getTime().
retryPrompt	(Optional) retry prompt to send if the users response isn't understood. Default is to just re-prompt with a customizable system prompt.
retrySpeak	(Optional) SSML to send with the retryPrompt. If the retryPrompt is of type IMessage or IIsMessage, this value will be ignored. If this value is an array a response will be chosen at random.
speak	(Optional) SSML to send with the initial prompt. If the prompt is of type IMessage or IIsMessage, this value will be ignored. If this value is an array a response will be chosen at random.
textFormat	Format of text fields. The default value is 'markdown'.

Property Details

attachmentLayout

Hint for how clients should layout multiple attachments. The default value is 'list'.

attachmentLayout?: string

Property Value

string

attachments

For incoming messages contains attachments like images sent from the user. For outgoing messages contains objects like cards or images to send to the user.

attachments?: IAttachment[]

Property Value

IAttachment[]

choices

(Optional) List of choices to present to the user. If omitted a PromptChoice.onChoices() handler should be provided.

choices?: IChoice[]

Property Value

IChoice[]

entities

Structured objects passed to the bot or user.

entities?: any[]

Property Value

any[]

inputHint

Hint for clients letting them know if the bot is expecting further input or not. The built-in prompts will automatically populate this value for outgoing messages.

inputHint?: string

Property Value

string

libraryNamespace

(Optional) namespace to use for localization and other purposes. This defaults to the callers namespace.

libraryNamespace?: string

Property Value

string

listStyle

(Optional) type of list to render for PromptType.choice. Default value is ListStyle.auto.

listStyle?: ListStyle

Property Value

ListStyle

localizationNamespace

DEPRECATED use libraryNamespace instead.

localizationNamespace?: string

Property Value

string

maxRetries

(Optional) maximum number of times to re-prompt the user. By default the user will be re-prompted indefinitely.

maxRetries?: number

Property Value

number

prompt

(Optional) Initial prompt to send the user. This is typically populated by the Prompts.xxx() function.

prompt?: TextOrMessageType

Property Value

TextOrMessageType

promptAfterAction

(Optional) flag used to control the re-prompting of a user after a dialog started by an action ends. The default value is true.

promptAfterAction?: boolean

Property Value

boolean

refDate

(Optional) reference date when recognizing times. Date expressed in ticks using Date.getTime().

refDate?: number

Property Value

number

retryPrompt

(Optional) retry prompt to send if the users response isn't understood. Default is to just re-prompt with a customizable system prompt.

retryPrompt?: TextOrMessageType

Property Value

TextOrMessageType

retrySpeak

(Optional) SSML to send with the retryPrompt. If the retryPrompt is of type IMessage or IIsMessage, this value will be ignored. If this value is an array a response will be chosen at random.

retrySpeak?: TextType

Property Value

TextType

speak

(Optional) SSML to send with the initial prompt. If the prompt is of type IMessage or IIsMessage, this value will be ignored. If this value is an array a response will be chosen at random.

speak?: TextType

Property Value

TextType

textFormat

Format of text fields. The default value is 'markdown'.

textFormat?: string

Property Value

string