TriggerBuilder

TriggerBuilder

Builder for rule Triggers

Classes

TriggerConf
ChannelTriggerConfig
CronTriggerConfig
ItemTriggerConfig
ThingTriggerConfig
SystemTriggerConfig

Methods

channel(channelName) → {TriggerBuilder.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
TriggerBuilder.ChannelTriggerConfig

cron(cronExpression) → {TriggerBuilder.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
TriggerBuilder.CronTriggerConfig

item(itemName) → {TriggerBuilder.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
TriggerBuilder.ItemTriggerConfig

memberOf(groupName) → {TriggerBuilder.ItemTriggerConfig}

Source:

Specifies an 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
TriggerBuilder.ItemTriggerConfig

thing(thingUID) → {TriggerBuilder.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
TriggerBuilder.ThingTriggerConfig

system() → {TriggerBuilder.SystemTriggerConfig}

Source:

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

Returns:

the trigger config

Type
TriggerBuilder.SystemTriggerConfig