BaseAutomation

interface BaseAutomation

Known direct subclasses
Automation

The main representation an automation, composed of various types of Automation nodes, including Starter instances, Condition instances, Action instances, and more.

Known indirect subclasses
MutableAutomation

Mutable attributes for an Automation.


Interface that is common between Automation and DraftAutomation.

Summary

Public properties

AppManagedAutomationConfig?

Configuration for app managed settings-based automations.

SequentialFlow?

List of Node instances.

AutomationSourceMetadata?

Metadata about the source of the automation.

String?

Unique identifier of the client feature group that the automation belongs to.

String

Description of this automation instance.

Boolean

Whether the automation can execute.

String

User given name for the automation.

Public properties

appManagedAutomationConfig

val appManagedAutomationConfigAppManagedAutomationConfig?

Configuration for app managed settings-based automations.

automationGraph

val automationGraphSequentialFlow?

List of Node instances. Nodes in the automation graph execute sequentially by default.

automationSourceMetadata

val automationSourceMetadataAutomationSourceMetadata?

Metadata about the source of the automation. For blueprint suggestions, this will contain the ID of the blueprint the suggestion was generated from.

clientFeatureGroup

val clientFeatureGroupString?

Unique identifier of the client feature group that the automation belongs to. This is used to group automations for specific client features (e.g. 3P settings-based automations).

description

val descriptionString

Description of this automation instance.

isActive

val isActiveBoolean

Whether the automation can execute.

name

val nameString

User given name for the automation.