Console

BaseAutomation 

protocol BaseAutomation : Identifiable, Sendable

A base protocol for all Automation instances.

  • id

    For existing automations, its identifier, unique for the users structure. For new automations, the identifier should be empty.

    Declaration

    Swift

    var id: String { get }

  • The structure this automation belongs to.

    Declaration

    Swift

    var structureID: String { get }

  • User given name for the automation.

    Declaration

    Swift

    var name: String { get }

  • Description of this automation instance.

    Declaration

    Swift

    var description: String { get }

  • Whether the automation will execute from starters.

    Declaration

    Swift

    var isActive: Bool { get }

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

    Declaration

    Swift

    var automationGraph: SequentialFlow? { get }

  • Field for first party clients to store client specific metadata.

    Declaration

    Swift

    var firstPartyClientMetadata: Data? { get }

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

    This field currently is restricted to be used by 1p clients only and is immutable.

    Declaration

    Swift

    var clientFeatureGroup: String? { get }

  • The number of times the automation has been executed. This field is only applicable to 1-time/n-time automations. Default nil if not set.

    Declaration

    Swift

    var executionCount: Int32? { get }

  • The maximum number of times the automation can be executed. This field is only applicable to 1-time/n-time automations. Default nil if not set.

    Declaration

    Swift

    var maxExecutionCount: Int32? { get }