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

event.create()

Create a new event record

See Also

rb.schedule.event.modify, remove()   

Syntax

number = rb.schedule.event.create(event, activate)

Parameters

The 'event.create' method takes 2 parameters:

Name Type/Value Range/Length Description
eventstruct event.eventDefsee definition Required. Structure containing the information from which the new schedule event is to be created
activatebool  Optional, default = 0
Set to true to attempt to activate the new event automatically

Results

The 'event.create' method returns number:

Type/Value Range/Length Description
number   Unique ID of the newly created event record, or: -1 if the record could not be created, -2 if the record is created but can't be activated.

Remarks

Create a new event record and return the ID of that record to the caller.

Whitebeam release 1.3.36
(loadtime : 121ms)