Show / Hide Table of Contents

Class PromptOptions

For setting up extra options when using line.Prompt

Inheritance
object
PromptOptions
MultiTryPromptOptions
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: ivrToolkit.Core.Util
Assembly: ivrToolkit.Core.dll
Syntax
public class PromptOptions

Properties

| Edit this page View Source

AllowEmpty

Lets blank be a valid answer. Only works if the evaluator parameter is null. If you supply the evaluator parameter then you are in total control of the validation. Default is true.

Declaration
public bool? AllowEmpty { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

AllowedDigits

The digits you are allowed to press in single digit mode. When you are set to single digit mode(MaxDigits=1) and you are not using an evaluator parameter, then this will be a list of digits that you are allowed to press.

Declaration
public string AllowedDigits { get; set; }
Property Value
Type Description
string
| Edit this page View Source

CatchTooManyAttempts

Set to false and the prompt will return a value of "". Set to true and TooManyAttemptsException will be thrown. Default is true.

Declaration
public bool? CatchTooManyAttempts { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

InvalidAnswerMessage

A wav file to be played if the answer is incorrect. If null then no message will be played.

Declaration
public string InvalidAnswerMessage { get; set; }
Property Value
Type Description
string
| Edit this page View Source

InvalidAnswerTtsCache

The TextToSpeechCache to use to play/generate an Invalidate Answer message. If null then no message will be played. ITextToSpeechCache

Declaration
public ITextToSpeechCache InvalidAnswerTtsCache { get; set; }
Property Value
Type Description
ITextToSpeechCache
| Edit this page View Source

MaxLength

The maximum number of digits that can be intered in the prompt. Default is 30.

Declaration
public int MaxLength { get; set; }
Property Value
Type Description
int
| Edit this page View Source

OnSpecialTerminator

The method to handle your special terminator digit.

Declaration
public Action OnSpecialTerminator { get; set; }
Property Value
Type Description
Action
| Edit this page View Source

SpecialTerminator

You can define special terminator digits that will fire the OnSpecialTerminator event. For example a '*' could take you to a special option to control volume.

Declaration
public string SpecialTerminator { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Terminators

List of one or more valid termination digits. The default is '#'. You can also use 'T' which will allow a timeout to be a valid termination key

Declaration
public string Terminators { get; set; }
Property Value
Type Description
string

Extension Methods

ValidationExtensions.ThrowIfNull<T>(T, string)
  • View Source
In this article
Back to top Generated by DocFX