element <bot:eventHandler>
Namespace:
http://www.zionsoftware.com/jbuddy/bot
Type:
bot:eventHandler
Content:
complex, 3 attributes, 17 elements
Defined:
locally at 1 location
XML Representation Summary
<bot:eventHandler
   
 consume
 = 
boolean
   
 ref
 = 
NMTOKEN
   
 type
 = 
("message" | "presence")
   
>
   
Content: 
bot:filters?, bot:routes?, (bot:action?, bot:addBuddy?, bot:removeBuddy?, bot:addDeny?, bot:removeDeny?, bot:addPermit?, bot:removePermit?, bot:content?, bot:file?, bot:menu?, bot:message?, bot:parameter?, bot:setPermitMode?, bot:setStatus?, bot:target?)*
</bot:eventHandler>
May contain elements (17):
bot:action,
bot:addBuddy,
bot:addDeny,
bot:addPermit,
bot:content (type bot:richContent),
bot:file,
bot:filters (type bot:filters),
bot:menu (type bot:menu),
bot:message,
bot:parameter,
bot:removeBuddy,
bot:removeDeny,
bot:removePermit,
bot:routes (type bot:routes),
bot:setPermitMode,
bot:setStatus,
bot:target (type bot:target)
May be included in elements (2):
bot:menu,
bot:menu (type bot:globalMenu)
Usage / Definition Locations
Annotation
This menu's local event handlers.

These event handlers can only be triggered if the user is viewing this menu.

Attribute Detail
consume
Sets whether this event handler consumes events.

If true, the engine will ignore further event handlers for an event after triggering this one.

Type:
boolean
Use:
optional
Defined:
locally, within bot:eventHandler complexType
ref
References another event handler by its id.

Attributes are inherited from the referenced event handler, and may be overridden. Filters, routes, and calls are also inherited; new ones defined in this event handler will be added to the inherited ones.

Type:
NMTOKEN
Use:
optional
Defined:
locally, within bot:eventHandler complexType
type
Sets the type of event that triggers this event handler.
Type:
bot:eventType
Use:
required
Defined:
locally, within bot:eventHandler complexType
Content Element Detail
bot:action
Executes an action.
Type:
embedded, complex content
Defined:
by reference, within bot:callElements group
bot:addBuddy
Adds a user to the client's buddy list.
Type:
embedded, empty content
Defined:
by reference, within bot:callElements group
bot:addDeny
Adds a user to the client's deny list.
Type:
embedded, empty content
Defined:
by reference, within bot:callElements group
bot:addPermit
Adds a user to the client's permit list.
Type:
embedded, empty content
Defined:
by reference, within bot:callElements group
bot:content
Sends content to a user.
Type:
bot:richContent, mixed content
Defined:
locally, within bot:callElements group
bot:file
Sends a file to a user.
Type:
embedded, complex content
Defined:
by reference, within bot:callElements group
bot:filters
Sets this event handler's filters.

An event may only trigger this event handler if the filters allow it.

Type:
bot:filters, complex content
Defined:
locally, within bot:eventHandler complexType
bot:menu
Sends a menu to a user.
Type:
bot:menu, complex content
Defined:
locally, within bot:callElements group
bot:message
Sends a message to a user.
Type:
embedded (extension of bot:richContent), complex content
Defined:
by reference, within bot:callElements group
bot:parameter
Asks a user for input.
Type:
embedded, complex content
Defined:
by reference, within bot:callElements group
bot:removeBuddy
Removes a user from the client's buddy list.
Type:
embedded, empty content
Defined:
by reference, within bot:callElements group
bot:removeDeny
Removes a user from the client's deny list.
Type:
embedded, empty content
Defined:
by reference, within bot:callElements group
bot:removePermit
Removes a user from the client's permit list.
Type:
embedded, empty content
Defined:
by reference, within bot:callElements group
bot:routes
Sets this event handler's routes.

This event handler's calls are processed for each specified route.

Type:
bot:routes, complex content
Defined:
locally, within bot:eventHandler complexType
bot:setPermitMode
Sets the bot's permit mode.
Type:
embedded, empty content
Defined:
by reference, within bot:callElements group
bot:setStatus
Sets the bot's status.
Type:
embedded, empty content
Defined:
by reference, within bot:callElements group
bot:target
Executes a target.
Type:
bot:target, complex content
Defined:
locally, within bot:callElements group
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