Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

rb.schedule.actionDef

Description of an 'action' to be optionally referenced by an event

Elements

The rb.schedule.actionDef struct has 10 elements:

Name Type/Value Range/Length Description
IDnumber  Optional, default = -1
The unique ID of this action
namestring  Optional. An identifying name for this action. REQUIRED FOR CREATE
typestring  Optional. An optional string available to the application for filtering
urlstring  Optional. URL to request in order to trigger this action. Required for create.
proxystring  Optional. Optional address (name/ip address:port) of an intermediate proxy device.
proxyTypestring  Optional. The type of the proxy referenced in 'proxy'. May be 'http', 'socks4', 'socks4a' or 'socks5' (case insensitive).
logbool  Optional. If 'true' then create a new log entry each time an event is triggered that's associated with this action
logBodybool  Optional. If 'true' (and 'log' is true) then events that trigger this action will store (up to 50K) of the HTTP response body in the log table.
sendParamsbool  Optional, default = 1
If 'true' then append wbsched-id and wbsched-logid to the trigger URL
customDataMetaData  Optional.

custom data against a action. This can be used to store information application to all events using this action - for example generic rules on how to process the action.


Whitebeam release 1.3.36
(loadtime : 190ms)