GaugeAlert

final class GaugeAlert : Identifiable

An alert that can be triggered based on a gauge reading value. Note: These alerts should only be triggered/processed in the background.

Lifecycle

Internal

  • id

    Declaration

    Swift

    let id: UUID { get }

  • The title of the alert.

    Declaration

    Swift

    var title: String { get set }

  • The message of the alert. This is optional. Used in the notification body.

    Declaration

    Swift

    var message: String? { get set }

  • The GaugeReading value that the alert is based on.

    Declaration

    Swift

    var valueMinimum: Double { get set }

  • Undocumented

    Declaration

    Swift

    var valueMaximum: Double? { get set }

  • The metric used to measure the gauge reading value (e.g. CFS, Feet, etc.)

    Declaration

    Swift

    var metric: GaugeMetric { get set }

  • The site ID of the gauge that the alert is based on.

    Declaration

    Swift

    var siteID: String { get set }

  • The criteria that the alert is based on.

    Declaration

    Swift

    var criteria: GaugeAlertCriteria { get set }

  • Whether or not the alert is active. i.e., users can pause or disable an alert if it is too noisy

    Declaration

    Swift

    var active: Bool { get set }

  • Undocumented

    Declaration

    Swift

    var createdAt: Date { get set }

  • Undocumented

    Declaration

    Swift

    var updatedAt: Date { get set }

  • The date and time that the alert was last triggered.

    Declaration

    Swift

    var lastTriggeredAt: Date? { get set }