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.action.actionSearchParams

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

Elements

The rb.schedule.action.actionSearchParams struct has 9 elements:

Name Type/Value Range/Length Description
IDnumber  Optional. If specified then return only this record
namestring  Optional. Wild-card match of the action name field
typestring  Optional. Wild-card match of the action type field
inUsebool  Optional.

If specified then: if 'true' only return actions that have at least one attached event; 'false' only records that do not have any attached events.

firstIndexnumber  Optional, default = 0
Offset from the start of the audit set to return in this iterator
maxRowsnumber  Optional, default = 0
Indication of the number of rows that will be used by the application. Note that the application is free to use more or less rows
allDatanumber  Optional, default = 15

Specifies the amount/type of data to be included in the response for a particular arc.

0 :return the action record except customData

1 :as '0' but include customData

Note each of these values represents a different set of data. You can select any or all data for a specific query. So for example a value of (1+2) would return all stored information. Currently only 2 bits are used, this may however be increased in future.

listeningForstring  Optional. Only return actions that are listening for triggers that match this wild card string
listeningForMatchTypenumber  Optional, default = 0

Specifies how to match the 'listeningFor' string against the current listenners:

  • 0: (default) - EXACT match - case insensitive
  • 1: Wildcard match using SQL 'SIMILAR TO' syntax

Whitebeam release 1.3.36
(loadtime : 56ms)