Cisco Cisco Unified Customer Voice Portal 10.5(1) 開発者ガイド

ページ / 98
C
HAPTER 
9:
 
C
ONFIGURABLE
 E
LEMENTS
 
 
V
OICE
XML
 
P
ROGRAMMING 
G
UIDE 
 
 
 
FOR 
C
ISCO 
U
NIFIED 
C
USTOMER 
V
OICE 
P
ORTAL 
R
ELEASE 
4.0(1) 
 
 
 
 
43
 
At this juncture, neither VoiceXML Studio nor the VoiceXML Server use the information 
returned from this method. One of the reasons is that for some elements, what element data is 
created may not be known until runtime. In future versions, VoiceXML Studio may utilize the 
results of this method to aid the application designer in choosing element data when using 
substitution. In the meantime, the method must be configured to return something, either 
null
 or 
at least one element data variable. 
Setting[] getSettings() 
This method describes the settings this element contains in its configuration. All element types 
have settings which allow a designer to control how the element functions when visited. 
VoiceXML Studio uses information returned in this method to render the Settings tab in the 
Element Configuration Pane. This method returns an array of 
Setting
 objects, where each 
Setting
 object represents a single setting rendered on a separate line in the Element 
Configuration Pane. The setting object lists the following information about a setting: 
    Its real and display name. VoiceXML Studio uses the display name in the Element 
Configuration Pane and the real name is used everywhere else (such as when referring to the 
setting in the element Java code). 
    The setting data type. The data type determines how the information is entered in VoiceXML 
Studio. The following lists the different data types available: 
o
 
Boolean.
 The boolean data type displays a dropdown menu with two options, true and 
false
o
 
Enumerated.
 The enumerated data type displays a dropdown menu with the options 
defined in the enumeration. 
o
  Float.
 The float data type displays a text box that accepts only floating point numbers. 
The setting can define upper and lower limits for the entered number.
 
o
  Integer.
 The integer data type displays a text box that accepts only integer numbers. The 
setting can define upper and lower limits for the entered number.
 
o
  String.
 The string data type displays a text box that accepts any input.
 
o
  Textbox.
 The textbox data type displays a button that when clicked produces a large text 
field that accepts any input. It should be used when text content tends to be long and it is 
desirable to give more space to enter the setting value than would normally be given with 
a string data type.
 
    Whether the setting is required or repeatable. A required setting is displayed with a red star 
next to it and VoiceXML Studio will not allow the application to be deployed or validated if 
this setting is left blank. A repeatable setting is displayed with a plus sign next to it and can 
be given multiple values by the application designer. A setting can be both required and 
repeatable in which case there must be at least one value. 
    Whether the setting allows substitution within it. Substitution is a mechanism for specifying 
the assembly of dynamic content in VoiceXML Studio at build time. A setting can be