event

event Structure: Event containing triggers to observe, conditions to test, and actions to perform.

event structure
unique ID unique ID
enabled boolean: default
name string
notes string: optional, default
image string: optional
tool string: optional
behaviours array of behaviour: optional, unique
triggers array of trigger
criteria criteria
actions array of action
access rights array of access rights

Description

event is the core unit of the engine. events are self contained.

event describes of a set of triggers to observe. When any one of these triggers fires, the criteria is tested. If the criteria is met at the time of triggering, the actions are performed in sequence.

The unique ID of event is the structure's key. When manipulating or tracking individual events, use this value.

Fields

unique ID

Unique identifier.

We recommend the unique ID is set to a CoreFoundation UUID using its UTF8 string representation. This ensures the event's unique ID is truely unique.

The engine indexes events by unique ID.

enabled

Is the event available to be scheduled and performed.

Setting enabled to true allows the engine to enqueue the event's triggers.

Setting enabled to false stops the engine from acting upon the event, even if the appropriate triggers fire.

name

Presentation name.

name need not be unique, but we recommend it is. The name should convay the purpose of the event. Try to suggest or pick names that touch upon the cause or outcome of the event.

notes

Notes about this event's purpose.

notes is provided to hold information about the event's purpose, intent, creator, and any other miscellaneous details that may be useful to other users. No specific format should be expected.

image

A Universal Image Identifer respresenting the event.

image is a Universal Image Identifer (UII). The image will be used is association with the event throughout the user interface.

tool

Owning tool in reverse domain name format.

tool is the reverse domain named formatted identifier of the tool that created or last manipulated this event. Used to help tools identify which events they claim responsibility for. A tool with limited functionality might restrict itself to attempting to edit or show only events with a tool entry matching their own identifier.

behaviours

Non-standard event behaviour.

Behaviours affect how the event is performed and allow the event to take on non-standard responses to situations such as requests to idle sleep, and parallel triggers.

triggers

Triggers determining when the event performs.

criteria

A criteria determining if the event performs.

The criteria is tested after a trigger fires. Only if the criteria is met, will the actions be performed.

actions

Actions performed when the event is successfully triggered.

List of actions performed in sequence after one of the's event triggers has fired, and the criteria has been met.

access rights

Caller rights for the event.

Access rights lists what the caller can do to this event. The rights are specific to the caller. access rights is read only. Any access rights passed into the Scheduler will be ignored.

Back to the previous page.