Whitebeam Template Reference Documentation

Whitebeam Template Reference Documentation

Schedule Template

event.activate()

Change the active schedule status for an event

See Also

rb.schedule.event.create, remove()

Syntax

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

Parameters

The 'event.activate' method takes 2 parameters:

Name	Type/Value	Range/Length	Description
ID	number		Required. Unique ID of the record to be changed
activate	bool		Required. Set to true to attempt to activate the new event automatically

Results

The 'event.activate' method returns number:

Type/Value	Range/Length	Description
number		Return -1 if the request can't be satisfied, otherwise the ID of the event

Remarks

Change the fields in a specific record.

Whitebeam release 1.3.36

(loadtime : 91ms)