InAppAutomation

public protocol InAppAutomation : AnyObject, Sendable

Provides a control interface for creating, canceling and executing in-app automations.

  • In-App Messaging

    Declaration

    Swift

    var inAppMessaging: any InAppMessaging { get }

  • Legacy In-App Messaging

    Declaration

    Swift

    var legacyInAppMessaging: any LegacyInAppMessaging { get }

  • Paused state of in-app automation.

    Declaration

    Swift

    @MainActor
var isPaused: Bool { get set }
  • upsertSchedules(_:) Asynchronous

    Creates the provided schedules or updates them if they already exist.

    Declaration

    Swift

    func upsertSchedules(_ schedules: [AutomationSchedule]) async throws

    Parameters

    schedules

    The schedules to create or update.

  • Cancels an in-app automation via its schedule identifier.

    Declaration

    Swift

    func cancelSchedule(identifier: String) async throws

    Parameters

    identifier

    The schedule identifier to cancel.

  • Cancels multiple in-app automations via their schedule identifiers.

    Declaration

    Swift

    func cancelSchedule(identifiers: [String]) async throws

    Parameters

    identifiers

    The schedule identifiers to cancel.

  • Cancels multiple in-app automations via their group.

    Declaration

    Swift

    func cancelSchedules(group: String) async throws

    Parameters

    group

    The group to cancel.

  • Gets the in-app automation with the provided schedule identifier.

    Declaration

    Swift

    func getSchedule(identifier: String) async throws -> AutomationSchedule?

    Parameters

    identifier

    The schedule identifier.

    Return Value

    The in-app automation corresponding to the provided schedule identifier.

  • getSchedules(group:) Asynchronous

    Gets the in-app automation with the provided group.

    Declaration

    Swift

    func getSchedules(group: String) async throws -> [AutomationSchedule]

    Parameters

    identifier

    The group to get.

    Return Value

    The in-app automation corresponding to the provided group.

  • statusUpdates Asynchronous

    Inapp Automation status updates. Possible values are upToDate, stale and outOfDate.

    Declaration

    Swift

    var statusUpdates: AsyncStream<InAppAutomationUpdateStatus> { get async }
  • status Asynchronous

    Current inApp Automation status. Possible values are upToDate, stale and outOfDate.

    Declaration

    Swift

    var status: InAppAutomationUpdateStatus { get async }
  • waitRefresh(maxTime:) Asynchronous

    Allows to wait for the refresh of the InApp Automation rules.

    Declaration

    Swift

    func waitRefresh(maxTime: TimeInterval?) async