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.event.eventSearch

Flags used to search for specific events

Elements

The rb.schedule.event.eventSearch struct has 16 elements:

Name Type/Value Range/Length Description
IDnumber  Optional. If specified return only the identified event record
minDatedate  Optional. Only return records with a date/time value greater than or equal to this value
maxDatedate  Optional. Only return records with a date/time value less than or equal to this value
includeDateRepeatsbool  Optional, default = 0
Used with min/maxDate. When searching include the repetitions of dates (start+'n'x'period)
typestring  Optional. Wild-card match of the event type record
minStatenumber  Optional. Only return events with a state value greater than or equal to this value
maxStatenumber  Optional. Only return events with a state value less than or equal to this value
actionIDnumber  Optional. If specified then only return events with this action ID
activebool  Optional.

If specified then only return events for which the 'active' state matches the value of this field.

contactIDnumber  Optional. Only return events that have this specific contact ID stored as the owner.
isInContactarray of numbers  Optional. If this array exists and is populated, then only return events that are attached on AT LEAST one of the specified contact IDs
isInContactAllLevelsbool  Optional, default = 0
If this flag is 'true' then each contact in isInContact is expanded to include all elements that inherit from that contact.
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 = 1

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

0 :return the event record except customData
1 :include event record customData
2 :include basic information about associated 'action' (if any)
4 :include full information about associated 'action' (if any), including custoData

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 3 bits are used.

sortBystring"ID" | "first" | "last" | "next" Optional, default = ID

If this optional field is specified then it determines the order in which matching records will be returned. ID is the event ID, 'next' is the next schedule time (and so only applicable to records that are 'active'. Preceed one of the sort names with '^' to reverse the search order.


Whitebeam release 1.3.36
(loadtime : 130ms)