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.triggerData()

Return the customData associated with a specific trigger

Syntax

MetaData Object = rb.schedule.action.triggerData(triggerID)

Parameters

The 'action.triggerData' method takes 1 parameter:

Name Type/Value Range/Length Description
triggerIDnumber  Required. The ID of the trigger - as passed to the action URL as 'wbsched-trigID' (form data)

Results

The 'action.triggerData' method returns a JavaScript object containing arbitrary attributes (Meta Value):

Type/Value Range/Length Description
MetaData   Return customData associated with a specific event, if the trigger source provided customData

Remarks

This method takes the unique ID of a trigger and returns the data associated with that trigger to the application. NOTE: triggers are transient and are deleted as soon as all the necessary action URLs have been called that are listening for that trigger. In practice this method is only useful in the action URL.

Whitebeam release 1.3.36
(loadtime : 115ms)