Classes
- ChannelTriggerConfig
- CronTriggerConfig
- DateTimeTriggerConfig
- ItemTriggerConfig
- SystemTriggerConfig
- ThingTriggerConfig
- TimeOfDayTriggerConfig
- TriggerConf
Methods
channel(channelName) → {ChannelTriggerConfig}
- Description:
Specifies a channel event as a source for the rule to fire.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
channelName |
string | the name of the channel |
Returns:
the trigger config
- Type
- ChannelTriggerConfig
cron(cronExpression) → {CronTriggerConfig}
- Description:
Specifies a cron schedule for the rule to fire.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
cronExpression |
string | the cron expression |
Returns:
the trigger config
- Type
- CronTriggerConfig
dateTime(itemName) → {DateTimeTriggerConfig}
- Description:
Specifies a DateTime Item whose (optional) date and time schedule the rule to fire.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
itemName |
string | the name of the Item to monitor for change |
Returns:
the trigger config
- Type
- DateTimeTriggerConfig
item(itemName) → {ItemTriggerConfig}
- Description:
Specifies an Item as the source of changes to trigger a rule.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
itemName |
string | the name of the Item |
Returns:
the trigger config
- Type
- ItemTriggerConfig
memberOf(groupName) → {ItemTriggerConfig}
- Description:
Specifies a group member as the source of changes to trigger a rule.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
groupName |
string | the name of the group |
Returns:
the trigger config
- Type
- ItemTriggerConfig
system() → {SystemTriggerConfig}
- Description:
Specifies a system event as a source for the rule to fire.
- Source:
Returns:
the trigger config
- Type
- SystemTriggerConfig
thing(thingUID) → {ThingTriggerConfig}
- Description:
Specifies a Thing status event as a source for the rule to fire.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
thingUID |
string | the UID of the Thing |
Returns:
the trigger config
- Type
- ThingTriggerConfig
timeOfDay(time) → {TimeOfDayTriggerConfig}
- Description:
Specifies a time schedule for the rule to fire.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
time |
string | the time expression (in |
Returns:
the trigger config
- Type
- TimeOfDayTriggerConfig