Prompt class

包:

botbuilder-calling

提示生成器类，用于简化 playPrompt 操作的生成提示。

构造函数

Prompt(CallSession)

创建提示生成器的新实例。

方法

culture(string)	要用于文本转语音的语言枚举值。 仅当 值 为文本时适用。 默认值为“en-US”。 请注意，当前 en-US 是唯一支持的语言。
emphasize(boolean)	指示是否在外出时强调。仅当 值 为文本时，它才适用。 默认值为 false。
file(CallSession, string)	创建将向用户播放的文件提示。
fileUri(string)	播放的媒体文件的 HTTP。 支持的格式为 WMA 或 WAV。 该文件的大小限制为 512kb，并由 Skype Bot Platform for Calling 缓存。 必须指定 值 或 fileUri。
sayAs(string)	SayAs 枚举值指示是否在 tts 期间自定义发音。 仅当 值 为文本时，它才适用。
silence(CallSession, number)	创建向用户播放静音的提示。
silenceLengthInMilliseconds(number)	在播放 价值 之前，任何沉默都播放。 如果 值 为 null，则此字段必须是有效的 > 0 值。
text(CallSession, string | string[], any[])	创建一个文本提示，该提示将使用 TTS 向用户朗读。
toPrompt()	返回提示的 JSON 对象。
value(string | string[], any[])	文本-To-Speech 要播放给 Skype 用户的文本。 必须指定 值 或 fileUri。
voice(string)	VoiceGender 枚举值。 默认值为“female”。

构造函数详细信息

Prompt(CallSession)

创建提示生成器的新实例。

new Prompt(session?: CallSession)

参数

session

CallSession

方法详细信息

culture(string)

要用于文本转语音的语言枚举值。 仅当 值 为文本时适用。 默认值为“en-US”。 请注意，当前 en-US 是唯一支持的语言。

function culture(locale: string)

参数

locale

string

返回

Prompt

emphasize(boolean)

指示是否在外出时强调。仅当 值 为文本时，它才适用。 默认值为 false。

function emphasize(flag: boolean)

参数

flag

boolean

返回

Prompt

file(CallSession, string)

创建将向用户播放的文件提示。

static function file(session: CallSession, uri: string)

参数

session

CallSession

uri

string

返回

Prompt

fileUri(string)

播放的媒体文件的 HTTP。 支持的格式为 WMA 或 WAV。 该文件的大小限制为 512kb，并由 Skype Bot Platform for Calling 缓存。 必须指定 值 或 fileUri。

function fileUri(uri: string)

参数

uri

string

返回

Prompt

sayAs(string)

SayAs 枚举值指示是否在 tts 期间自定义发音。 仅当 值 为文本时，它才适用。

function sayAs(type: string)

参数

type

string

返回

Prompt

silence(CallSession, number)

创建向用户播放静音的提示。

static function silence(session: CallSession, time: number)

参数

session

CallSession

time

number

返回

Prompt

silenceLengthInMilliseconds(number)

在播放 价值 之前，任何沉默都播放。 如果 值 为 null，则此字段必须是有效的 > 0 值。

function silenceLengthInMilliseconds(time: number)

参数

time

number

返回

Prompt

text(CallSession, string | string[], any[])

创建一个文本提示，该提示将使用 TTS 向用户朗读。

static function text(session: CallSession, text: string | string[], args: any[])

参数

session

CallSession

text

string | string[]

args

any[]

返回

Prompt

toPrompt()

返回提示的 JSON 对象。

function toPrompt()

返回

IPrompt

value(string | string[], any[])

文本-To-Speech 要播放给 Skype 用户的文本。 必须指定 值 或 fileUri。

function value(text: string | string[], args: any[])

参数

text

string | string[]

args

any[]

返回

Prompt

voice(string)

VoiceGender 枚举值。 默认值为“female”。

function voice(gender: string)

参数

gender

string

返回

Prompt