element <bot:parameter>
Namespace:
http://www.zionsoftware.com/jbuddy/bot
Type:
embedded complexType
Content:
complex, 11 attributes, 2 elements
Defined:
globally in bot.xsd
Used:
at 1 location
XML Representation Summary
<bot:parameter
   
 cancelCommand
 = 
NMTOKEN
   
 dateFormat
 = 
string
   
 dateStyle
 = 
("short" | "medium" | "long" | "full")
   
 hidden
 = 
boolean
   
 locale
 = 
string
   
 name
 = 
NMTOKEN
   
 numberFormat
 = 
string
   
 pattern
 = 
string
   
 timeStyle
 = 
("short" | "medium" | "long" | "full")
   
 type
 = 
("string" | "boolean" | "int" | "long" | "double" | "number" | "currency" | "percent" | "date" | "time" | "date-time")
   
 value
 = 
string
   
>
   
Content: 
bot:description?, bot:pattern?
</bot:parameter>
May contain elements (2):
bot:description (type bot:richContent),
bot:pattern (type bot:pattern)
May be included in elements (4):
bot:eventHandler (type bot:eventHandler),
bot:eventHandler (type bot:globalEventHandler),
bot:target,
bot:target (type bot:globalTarget)
Known Usage Locations
Embedded Type Detail
Annotation
Asks a user for input.

The user is prompted with the parameter's description. They may then enter a value for the parameter. The value's expected format depends on the parameter's type, as well as any validation patterns that may be set.

A user's parameter values may be recalled from within a Java BotActionTask (for more information, see the javadocs included with the framework). They may also be referenced by their parameter names using content variables. For example, the following target asks for user input, then echos back the values:

<target command="entername"> <parameter name="first"> <description>Enter your first name:</description> </parameter> <parameter name="last"> <description>Enter your last name:</description> </parameter> <content>You entered: ${first} ${last}</content> </target>

Parameters may also be hidden. In this case, a value is explicitly set, and users are not prompted to enter a value.

Attribute Detail
cancelCommand
Sets the cancel command.

A user can enter this command to cancel the parameter, instead of entering a value. This also cancels further execution of the target or event handler that called this parameter.

The default cancel command is "cancel".

Type:
NMTOKEN
Use:
optional
Defined:
locally, within this element
dateFormat
Sets the date format to use.

Accepts patterns as defined in java.text.SimpleDateFormat.

Valid only for date, time, and date-time parameters.

Type:
string
Use:
optional
Defined:
locally, within this element
dateStyle
The date style to use.

Valid only for date and date-time parameters.

Type:
bot:dateTimeStyle
Use:
optional
Defined:
locally, within this element
hidden
Sets whether this parameter is hidden.

If true, users will not be prompted to enter a value for this parameter.

The default value is false.

Type:
boolean
Use:
optional
Defined:
locally, within this element
locale
The locale to use for this parameter.

Affects the accepted values/syntax for number, date, and time-related parameters.

Type:
bot:locale
Use:
optional
Defined:
locally, within this element
name
Sets this parameter's name.
Type:
NMTOKEN
Use:
required
Defined:
locally, within this element
numberFormat
Sets the number format to use.

Accepts patterns as defined in java.text.DecimalFormat.

Valid only for number, currency, and percent parameters.

Type:
string
Use:
optional
Defined:
locally, within this element
pattern
Sets a validation pattern.

If any patterns are set, a user value must match at least one of them to be considered valid. If a user value is not valid, the user is sent an error message and prompted again to enter a value.

Type:
string
Use:
optional
Defined:
locally, within this element
timeStyle
The time style to use.

Valid only for time and date-time parameters.

Type:
bot:dateTimeStyle
Use:
optional
Defined:
locally, within this element
type
Sets this parameter's type.
Type:
bot:parameterType
Use:
optional
Defined:
locally, within this element
value
Sets this parameter's value.

If this parameter is hidden, this value is used, and users will not be prompted to enter a value for this parameter. Otherwise, users will be prompted, and this value will be ignored.

This value can contain content variables.

Type:
string
Use:
optional
Defined:
locally, within this element
Content Element Detail
bot:description
Sets this parameter's description.

This is the message the user is prompted with. If a description is not specified, a reasonable default is used.

Type:
bot:richContent, mixed content
Defined:
locally, within this element
bot:pattern
Sets a validation pattern.

If any patterns are set, a user value must match at least one of them to be considered valid. If a user value is not valid, the user is sent an error message and prompted again to enter a value.

Type:
bot:pattern, mixed content
Defined:
locally, within this element
XML Schema documentation generated with DocFlex/XML (Kit) v1.6.0
DocFlex/XML is a powerful template-driven documentation and report generator from any data stored in XML files. Based on an innovative technology developed by FILIGRIS WORKS, this new tool offers virtuoso data querying and formatting capabilities not found in anything else!
Need to convert your XML data into a clear nice-looking documentation or reports? Web-ready hypertext HTML or printable MS Word / OpenOffice.org friendly RTF? DocFlex/XML may be a cheap, quick and effective solution exactly for this task!
Have questions? Not sure how to use it? Just send us e-mail to contact@filigris.com and we are always happy to help you! See also our services at www.filigris.com