Contents

timerState

An enum schema for a timer state parameter.

Declaration

var timerState: 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 timerState schema, you can generate the protocol conformance the schema requires for your app enum implementation with the @AppEnum( .clock.timerState) 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 timerState schema:

@AppEnum(schema: .clock.timerState)
enum TimerState: String {
    case firing
    case paused
    case running
    case undefined

    static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [
        .firing: "Firing",
        .paused: "Paused",
        .running: "Running",
        .undefined: "Undefined"
    ]
}

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