IPromptOptions interface
Options passed to the built-in prompts.
- Extends
Properties
| attachment |
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. |
| entities | Structured objects passed to the bot or user. |
| input |
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. |
| library |
(Optional) namespace to use for localization and other purposes. This defaults to the callers namespace. |
| list |
(Optional) type of list to render for PromptType.choice. Default value is ListStyle.auto. |
| localization |
DEPRECATED use libraryNamespace instead. |
| max |
(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 |
| prompt |
(Optional) flag used to control the re-prompting of a user after a dialog started by an action ends. The default value is true. |
| ref |
(Optional) reference date when recognizing times. Date expressed in ticks using Date.getTime(). |
| retry |
(Optional) retry prompt to send if the users response isn't understood. Default is to just re-prompt with a customizable system prompt. |
| retry |
(Optional) SSML to send with the |
| speak | (Optional) SSML to send with the initial |
| text |
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?: stringProperty 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
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?: stringProperty Value
string
libraryNamespace
(Optional) namespace to use for localization and other purposes. This defaults to the callers namespace.
libraryNamespace?: stringProperty Value
string
listStyle
(Optional) type of list to render for PromptType.choice. Default value is ListStyle.auto.
listStyle?: ListStyleProperty Value
localizationNamespace
maxRetries
(Optional) maximum number of times to re-prompt the user. By default the user will be re-prompted indefinitely.
maxRetries?: numberProperty Value
number
prompt
(Optional) Initial prompt to send the user. This is typically populated by the Prompts.xxx() function.
prompt?: TextOrMessageTypeProperty Value
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?: booleanProperty Value
boolean
refDate
(Optional) reference date when recognizing times. Date expressed in ticks using Date.getTime().
refDate?: numberProperty 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?: TextOrMessageTypeProperty Value
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?: TextTypeProperty Value
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?: TextTypeProperty Value
textFormat
Format of text fields. The default value is 'markdown'.
textFormat?: stringProperty Value
string