AutomationSchedule

public struct AutomationSchedule : Sendable, Codable, Equatable

Automation schedule

  • Schedule data

    See more

    Declaration

    Swift

    public enum ScheduleData : Sendable, Equatable

  • The schedule ID.

    Declaration

    Swift

    public let identifier: String

  • List of triggers

    Declaration

    Swift

    public var triggers: [AutomationTrigger]

  • Optional schedule group. Can be used to cancel a set of schedules.

    Declaration

    Swift

    public var group: String?

  • Priority for determining order during simultaneous schedule processing

    Declaration

    Swift

    public var priority: Int?

  • Number of times the schedule can execute.

    Declaration

    Swift

    public var limit: UInt?

  • Start date

    Declaration

    Swift

    public var start: Date?
  • end

    End date

    Declaration

    Swift

    public var end: Date?

  • On device automation selector

    Declaration

    Swift

    public var audience: AutomationAudience?

  • Compoud audience. If both audience and compoundAudience, they will both be evaluated to determine if the schedule should be executed.

    Declaration

    Swift

    public var compoundAudience: AutomationCompoundAudience?

  • Delay after trigger and prepare steps before execution

    Declaration

    Swift

    public var delay: AutomationDelay?

  • Execution interval.

    Declaration

    Swift

    public var interval: TimeInterval?

  • Schedule data

    Declaration

    Swift

    public var data: ScheduleData

  • If the schedule should bypass holdout groups or not

    Declaration

    Swift

    public var bypassHoldoutGroups: Bool?

  • After the schedule ends or is finished, how long to hold on to the schedule before deleting it. This is used to keep schedule state around for a period of time after the schedule finishes to allow for extending the schedule.

    Declaration

    Swift

    public var editGracePeriodDays: UInt?

  • <#Description#>

    Declaration

    Swift

    public init(
    identifier: String,
    triggers: [AutomationTrigger],
    data: ScheduleData,
    group: String? = nil,
    priority: Int? = nil,
    limit: UInt? = nil,
    start: Date? = nil,
    end: Date? = nil,
    audience: AutomationAudience? = nil,
    compoundAudience: AutomationCompoundAudience? = nil,
    delay: AutomationDelay? = nil,
    interval: TimeInterval? = nil,
    bypassHoldoutGroups: Bool? = nil,
    editGracePeriodDays: UInt? = nil
)

    Parameters

    identifier

    The schedule ID
    triggers

    List of triggers for the schedule
    data

    Schedule data
    group

    Schedule group that can be used to cancel a set of schedules
    priority

    Priority for determining order during simultaneous schedule processing
    limit

    Number of times the schedule can execute
    start

    Start date
    end

    End date
    audience

    On device automation selector
    compoundAudience

    Compound automation selector
    delay

    Duration after trigger and prepare steps after which execution occurs
    interval

    Execution interval
    bypassHoldoutGroups

    If the schedule should bypass holdout groups or not
    editGracePeriodDays

    Duration after which post-execution deletion occurs

  • Declaration

    Swift

    public init(from decoder: any Decoder) throws

  • Declaration

    Swift

    public func encode(to encoder: any Encoder) throws