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.alias.aliasQueryData

Flags used in 'rb.alias.get'

Elements

The rb.alias.aliasQueryData struct has 7 elements:

Name Type/Value Range/Length Description
sortBystring  Optional, default = alias

Values are: 'alias', 'contactID', 'order'. If the first character is a '^' then the order is reversed . The default is 'order'

Available from version : 1.3.33

aliasstring  Optional. Wild-card match against the 'alias' field to filter the result set
typestring  Optional. Wild-card match against the 'type' field to filter the result set
contactIdListarray of numbers  Optional. Restrict results to aliases assocated with one of the contact IDs in this set
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 = 0

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

'0' : return everything except 'customData'

1 :include customData
2 :Basic contact information
4 :Include contact's 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+4) would return audit information plus a basic copy of the entity that is the subject of that record


Whitebeam release 1.3.36
(loadtime : 187ms)