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

Schedule Template

action.trigger()

Fire a trigger into the event system

Syntax

number = rb.schedule.action.trigger(trigger, contactID, customData)

Parameters

The 'action.trigger' method takes 3 parameters:

Name Type/Value Range/Length Description
triggerstring  Required. The unique name of the trigger we're firing into the system
contactIDnumber  Required. The ID of the contact associated with this trigger
customDataMetaData  Optional.

custom data against this trigger. This can be interrogated by the action called action URL.


Results

The 'action.trigger' method returns number:

Type/Value Range/Length Description
number   Unique ID of the new system trigger

Remarks

This method fires an anoymous trigger into the scheduler. This will be matched against all active listener records and the system will call the action ID for all matching 'event' records.

Whitebeam release 1.3.36
(loadtime : 188ms)