TriggerBuilder

TriggerBuilder

Builder for rule Triggers

Classes

TriggerConf
ChannelTriggerConfig
CronTriggerConfig
TimeOfDayTriggerConfig
ItemTriggerConfig
ThingTriggerConfig
SystemTriggerConfig
DateTimeTriggerConfig

Methods

channel(channelName) → {ChannelTriggerConfig}

Source:

Specifies a channel event as a source for the rule to fire.

Parameters:
Name Type Description
channelName string

the name of the channel

Returns:

the trigger config

Type
ChannelTriggerConfig

cron(cronExpression) → {CronTriggerConfig}

Source:

Specifies a cron schedule for the rule to fire.

Parameters:
Name Type Description
cronExpression string

the cron expression

Returns:

the trigger config

Type
CronTriggerConfig

timeOfDay(time) → {TimeOfDayTriggerConfig}

Source:

Specifies a time schedule for the rule to fire.

Parameters:
Name Type Description
time string

the time expression (in HH:mm) defining the triggering schedule

Returns:

the trigger config

Type
TimeOfDayTriggerConfig

item(itemName) → {ItemTriggerConfig}

Source:

Specifies an Item as the source of changes to trigger a rule.

Parameters:
Name Type Description
itemName string

the name of the Item

Returns:

the trigger config

Type
ItemTriggerConfig

memberOf(groupName) → {ItemTriggerConfig}

Source:

Specifies a group member as the source of changes to trigger a rule.

Parameters:
Name Type Description
groupName string

the name of the group

Returns:

the trigger config

Type
ItemTriggerConfig

thing(thingUID) → {ThingTriggerConfig}

Source:

Specifies a Thing status event as a source for the rule to fire.

Parameters:
Name Type Description
thingUID string

the UID of the Thing

Returns:

the trigger config

Type
ThingTriggerConfig

system() → {SystemTriggerConfig}

Source:

Specifies a system event as a source for the rule to fire.

Returns:

the trigger config

Type
SystemTriggerConfig

dateTime(itemName) → {DateTimeTriggerConfig}

Source:

Specifies a DateTime Item whose (optional) date and time schedule the rule to fire.

Parameters:
Name Type Description
itemName string

the name of the Item to monitor for change

Returns:

the trigger config

Type
DateTimeTriggerConfig