Prompts class
可从任何对话调用的内置内置提示。
- 扩展
方法
| action(Call |
将 wrokflow 操作作为提示发送给用户。 允许处理原始结果 |
| begin<T>(Call |
启动新的对话会话时调用。 |
| choice(Call |
提示用户从选项列表中选择。 |
| configure(IPrompts |
更新提示对话框的全局选项。 |
| confirm(Call |
提示用户使用“是/否”响应确认操作。 |
| dialog |
子对话已结束,当前对话正在恢复。 |
| digits(Call |
提示用户输入数字序列。 |
| record(Call |
提示用户记录消息。 |
| reply |
处理从用户收到的消息。 由对话框系统调用。 |
方法详细信息
action(CallSession, IAction | IIsAction)
将 wrokflow 操作作为提示发送给用户。 允许处理原始结果
static function action(session: CallSession, action: IAction | IIsAction)
参数
- session
- CallSession
当前会话的会话对象。
begin<T>(CallSession, T)
启动新的对话会话时调用。
function begin<T>(session: CallSession, args?: T)
参数
- session
- CallSession
当前会话的会话对象。
- args
-
T
(可选)由其父级传递给对话框的参数。
choice(CallSession, string | string[] | IAction | IIsAction, IRecognitionChoice[], IRecognizerPromptOptions)
提示用户从选项列表中选择。
static function choice(session: CallSession, playPrompt: string | string[] | IAction | IIsAction, choices: IRecognitionChoice[], options?: IRecognizerPromptOptions)
参数
- session
- CallSession
当前会话的会话对象。
- playPrompt:{string} - 发送用户的初始消息。
- playPrompt:{string[]} - 发送用户可能的消息数组。 随机选择一个。
- playPrompt:{IAction|IIsAction} - 用于发送用户的初始 PlayPrompt 操作。
- choices
用于提示用户的选项列表。
- options
- IRecognizerPromptOptions
(可选)参数来控制提示的行为。
configure(IPromptsSettings)
更新提示对话框的全局选项。
static function configure(settings: IPromptsSettings)
参数
- settings
- IPromptsSettings
要设置的选项。
confirm(CallSession, string | string[] | IAction | IIsAction, IConfirmPromptOptions)
提示用户使用“是/否”响应确认操作。
static function confirm(session: CallSession, playPrompt: string | string[] | IAction | IIsAction, options?: IConfirmPromptOptions)
参数
- session
- CallSession
当前会话的会话对象。
- playPrompt:{string} - 发送用户的初始消息。
- playPrompt:{string[]} - 发送用户可能的消息数组。 随机选择一个。
- playPrompt:{IAction|IIsAction} - 用于发送用户的初始 PlayPrompt 操作。
- options
- IConfirmPromptOptions
(可选)参数来控制提示的行为。
dialogResumed<T>(CallSession, IDialogResult<T>)
子对话已结束,当前对话正在恢复。
function dialogResumed<T>(session: CallSession, result: IDialogResult<T>)
参数
- session
- CallSession
当前会话的会话对象。
- result
子对话返回的结果。
digits(CallSession, string | string[] | IAction | IIsAction, number, IDigitsPromptOptions)
提示用户输入数字序列。
static function digits(session: CallSession, playPrompt: string | string[] | IAction | IIsAction, maxDigits: number, options?: IDigitsPromptOptions)
参数
- session
- CallSession
当前会话的会话对象。
- playPrompt:{string} - 发送用户的初始消息。
- playPrompt:{string[]} - 发送用户可能的消息数组。 随机选择一个。
- playPrompt:{IAction|IIsAction} - 用于发送用户的初始 PlayPrompt 操作。
- maxDigits
-
number
允许的最大位数。
- options
- IDigitsPromptOptions
(可选)参数来控制提示的行为。
record(CallSession, string | string[] | IAction | IIsAction, IRecordPromptOptions)
提示用户记录消息。
static function record(session: CallSession, playPrompt: string | string[] | IAction | IIsAction, options?: IRecordPromptOptions)
参数
- session
- CallSession
当前会话的会话对象。
- playPrompt:{string} - 发送用户的初始消息。
- playPrompt:{string[]} - 发送用户可能的消息数组。 随机选择一个。
- playPrompt:{IAction|IIsAction} - 用于发送用户的初始 PlayPrompt 操作。
- options
- IRecordPromptOptions
(可选)参数来控制提示的行为。
replyReceived(CallSession)
处理从用户收到的消息。 由对话框系统调用。
function replyReceived(session: CallSession)
参数
- session
- CallSession
当前会话的会话对象。