RecognizeAction class

Package:

botbuilder-calling

Action builder class designed to simplify building recognize actions.

Constructors

RecognizeAction(CallSession)

Creates a new instance of the action builder.

Methods

bargeInAllowed(boolean)	Indicates if Skype user is allowed to enter choice before the prompt finishes. The default value is true.
choices(IRecognitionChoice[])	List of RecognitionOption objects dictating the recognizable choices. Choices can be speech or dial pad digit based. Either collectDigits or choices must be specified, but not both.
collectDigits(ICollectDigits)	CollectDigits will result in collecting digits from Skype user dial pad as part of recognize. Either collectDigits or choices must be specified, but not both.
culture(string)	Culture is an enum indicating what culture the speech recognizer should use. The default value is “en-US”. Currently the only culture supported is en-US.
initialSilenceTimeoutInSeconds(number)	Maximum initial silence allowed before failing the operation from the time we start the recording. The default value is 5 seconds.
interdigitTimeoutInSeconds(number)	Maximum allowed time between dial pad digits. The default value is 1 second.
playPrompt(IAction | IIsAction)	A prompt to be played before the recognition starts.
toAction()	Returns the JSON object for the action.

Constructor Details

RecognizeAction(CallSession)

Creates a new instance of the action builder.

new RecognizeAction(session?: CallSession)

Parameters

session

CallSession

Method Details

bargeInAllowed(boolean)

Indicates if Skype user is allowed to enter choice before the prompt finishes. The default value is true.

function bargeInAllowed(flag: boolean)

Parameters

flag

boolean

Returns

RecognizeAction

choices(IRecognitionChoice[])

List of RecognitionOption objects dictating the recognizable choices. Choices can be speech or dial pad digit based. Either collectDigits or choices must be specified, but not both.

function choices(list: IRecognitionChoice[])

Parameters

list

IRecognitionChoice[]

Returns

RecognizeAction

collectDigits(ICollectDigits)

CollectDigits will result in collecting digits from Skype user dial pad as part of recognize. Either collectDigits or choices must be specified, but not both.

function collectDigits(options: ICollectDigits)

Parameters

options

ICollectDigits

Returns

RecognizeAction

culture(string)

Culture is an enum indicating what culture the speech recognizer should use. The default value is “en-US”. Currently the only culture supported is en-US.

function culture(locale: string)

Parameters

locale

string

Returns

RecognizeAction

initialSilenceTimeoutInSeconds(number)

Maximum initial silence allowed before failing the operation from the time we start the recording. The default value is 5 seconds.

function initialSilenceTimeoutInSeconds(time: number)

Parameters

time

number

Returns

RecognizeAction

interdigitTimeoutInSeconds(number)

Maximum allowed time between dial pad digits. The default value is 1 second.

function interdigitTimeoutInSeconds(time: number)

Parameters

time

number

Returns

RecognizeAction

playPrompt(IAction | IIsAction)

A prompt to be played before the recognition starts.

function playPrompt(action: IAction | IIsAction)

Parameters

action

IAction | IIsAction

Returns

RecognizeAction

toAction()

Returns the JSON object for the action.

function toAction()

Returns

IAction