PublishAlertAction

LiveView.AlertRule. PublishAlertAction

new PublishAlertAction(settingsopt)

Action that will publish a LiveView Alert.
Parameters:
Name Type Attributes Description
settings Object <optional>
 An object containing initial values for the new PublishAlertAction instance.
Properties
Name Type Attributes Description
fieldSubstitutions Object <optional>
 A key-value map that maps a tuple field name to place holder string. For example "category":"$category".
messageTemplate String <optional>
 A message template that will be filled in using the values in the fieldSubstitutions map.
alertKey String <optional>
 A parametrized string identifier for the Alert.
alertRecipient String <optional>
 The username of an intended recipient of the alert. The default is "*" to indicate "anyone".

Extends

Members

alertKey :String

A parametrized string identifier for the Alert
Type:
  • String

alertRecipient :String

The username of an intended recipient of the alert. The default is "*" to indicate "anyone".
Type:
  • String

enabled :boolean

Inherited From:
Flag indicating whether or not the Action is enabled (i.e. currently being used to determine whether or not to fire alerts).
Type:
  • boolean

fieldSubstitutions :Object

A key-value map of field name to place holder string. For example "category":"$category".
Type:
  • Object

messageTemplate :String

A message template that will be filled in using the values in the fieldSubstitutions map.
Type:
  • String