The InputAttributes class

The InputAttributes class contains properties which determine how the caller is guided through giving input using the Call.playAndGetInput() method, and how their response is validated. The properties defined in the InputAttributes class are listed below; each property has set and get methods.

Message properties

message: the prompt that is played to the caller before the application waits for their response.
invalidInputMessage: a message that is played when the caller has provided input that is considered invalid by the application. For example, if the application is expecting a telephone number that begins with a 2, and the caller has entered a number beginning with a 6, the application might say "That is not a valid phone number".
oneMoreRepeatMessage: a message that is played before the caller is prompted for input for the last time. Use the numberOfRepeats property to set the number of times the prompt will be played. For example, if the user has not provided a valid telephone number so far, the application might want to warn the user that they only have one more chance by saying "You have one more chance to enter a valid phone number".
noMoreRepeatsMessage: a message that is played after the last time the prompt has been repeated. For example, if the caller has not provided any valid input and the application will no longer repeat the prompt, the application might say “Sorry, we cannot continue, as you have not entered any valid input”.
timeoutMessage: a message that is played when the caller has failed to provide input before the timeout value is reached. For example, if the user does not respond in time the application might inform them of this by saying "You did not provide any input. Please try again".

Other properties

numberOfRepeats: the number of times the application will play the prompt if no valid input is received. (The total number of chances the caller has is numberOfRepeats + 1.)
validator: sets the validator object to be used for the input. The validator object is an instance of a class that implements the InputValidator interface. Each time the caller gives input the validate() method of the validator object will be called to check the input. For example, if the application needs to accept only telephone numbers beginning with a 2, you create a class, implementing the InputValidator interface, to check this, and then set an instance of your class as the validator object. For more information see Validating input
clearDTMFBuffer: specifies whether to clear the dual tone multifrequency (DTMF) buffer before input takes place. Set this property to true to ignore keys that have been pressed previously by the caller. This property also applies when using speech recognition — setting the property to true will clear the voice interrupted flag.
timeout: the time in seconds to wait for the caller's input. Specify -1 to wait for ever. If you specify 0, the caller will not have a chance to provide input. Note that the timeout is an 'interdigit timeout': when the caller is pressing keys, the timeout period is reset after each key is pressed.

For the message properties, the message object to be played can be a MediaType object, an array of MediaType objects, or an instance of a class that implements the Playable interface.

The constructor methods for this class are:

InputAttributes(): Constructs an InputAttributes object with null for all messages and the validator, and default properties of timeout=-1, clearDTMFBuffer=false and numberOfRepeats=1.
InputAttributes(InputAttributes base): Constructs an InputAttributes object with properties inherited from the specified InputAttributes.
InputAttributes(MediaType[] message, int timeout): Constructs an InputAttributes object with specified main message as an array of MediaType objects, and specified timeout.
InputAttributes(MediaType message, int timeout): Constructs an InputAttributes object with specified main message as a single MediaType, and specified timeout.
InputAttributes(Playable message, int timeout): Constructs an InputAttributes object with specified main message as a Playable object, and specified timeout.

For example:

public class myVoiceApp extends WVRApplication {
  .
  .
  .
  // Create the voice segment objects that will be used for the prompt
  public VoiceSegment vs_card_number = new VoiceSegment("OrderSegments", "CardNumber");
  public VoiceSegment vs_not_enough_digits = new VoiceSegment("OrderSegments", "NotEnough");
  public VoiceSegment vs_invalid = new VoiceSegment("OrderSegments", "Invalid");
  // Create the attributes object - use empty constructors so that attributes have
  // default values
  public InputAttributes myInputAtts = new InputAttributes();
  // Then change the attributes you need.
  myInputAtts.setMessage(vs_card_number);
  myInputAtts.setTimeoutMessage(vs_not_enough_digits);
  myInputAtts.setInvalidInputMessage(vs_invalid);
  myInputAtts.setTimeout(5);
  myInputAtts.setNumberOfRepeats(3);
  .
  .
  .
  // Within the voiceMain() method, use the attributes object to get input from the caller
  InputResult input = call.playAndGetInput(myPlayAtts, myInputAtts, myDTMFAtts, myRecoAtts);
}

Example interaction

You set the numberOfRepeats to 3. This gives the caller a total of four chances to enter data.

Iteration	Property used by object	Words spoken by application	Caller response
1	message	Enter your credit card number. The number must be 16 digits.	Does not press any keys, or presses fewer than 16.
2	timeoutMessage	You did not enter enough data.	Presses #12# *123 ###8 8888 (an invalid number).
	message	Enter your credit card number. The number must be 16 digits.	Presses #12# *123 ###8 8888 (an invalid number).
3	invalidInputMessage	That is not a valid credit card number.	Does not press any keys, or presses fewer than 16.
	message	Enter your credit card number. The number must be 16 digits.	Does not press any keys, or presses fewer than 16.
4	timeoutMessage	You did not enter 16 digits.	Presses #12# *123 ###8 8888 (an invalid number).
	oneMoreRepeatMessage	You have one more chance...
	message	Enter your credit card number. The number must be 16 digits.
5	invalidInputMessage	That is not a valid credit card number.
	noMoreRepeatsMessage	Sorry, we cannot continue with the transaction.