alarmTriggerState

Declaration

var alarmTriggerState: some AppSchemaEnum { get }

Discussion

To make your app’s parameter types available to Apple Intelligence, conform your AppEnum to a schema that describes a parameter’s possible values to the system. If your app’s functionality aligns with the clock domain and a parameter type matches the alarmTriggerState schema, you can generate the protocol conformance the schema requires for your app enum implementation with the @AppEnum( .clock.alarmTriggerState) Swift macro. To make your app work with Siri, see Apple Intelligence and Siri AI.

The following example shows an app enum that conforms to the alarmTriggerState schema:

@AppEnum(schema: .clock.alarmTriggerState)
enum AlarmTriggerState: String {
    case firing
    case snoozed
    case none

    static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [
        .firing: "Firing",
        .snoozed: "Snoozed",
        .none: "None"
    ]
}

The schema supports the following system experiences:

• Siri

• Shortcuts

For more information about the App Intents framework and the experiences it supports, see Getting started with the App Intents framework.

See Also

Types for static parameters

• timerState
• AppSchema.ClockEnum