One Logo Pool Ball
AppIntents · IOS API REFERENCE

AppSchema.ClockEnum

protocol · iOS 27.0+ · SDK 27.1

protocol ClockEnum : AppSchema.Kind

Identifies enum schemas in the clock domain.

Members (3)

get · iOS 27.0+

timerState

Swift declaration
var timerState: some AppSchemaEnum { get }

An enum schema for a timer state parameter. 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 <doc://com.apple.documentation/documentation/appintents/apple-intelligence-and-siri-ai>. The following example shows an app enum that conforms to the `timerState` schema: ```swift @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 <doc://com.apple.documentation/documentation/appintents/getting-started-with-the-app-intents-framework>.

get · iOS 27.0+

stopwatchState

Swift declaration
var stopwatchState: some AppSchemaEnum { get }

An enum schema for a stopwatch state parameter. 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 `stopwatchState` schema, you can generate the protocol conformance the schema requires for your app enum implementation with the `@AppEnum( .clock.stopwatchState)` Swift macro. To make your app work with Siri, see <doc://com.apple.documentation/documentation/appintents/apple-intelligence-and-siri-ai>. The following example shows an app enum that conforms to the `stopwatchState` schema: ```swift @AppEnum(schema: .clock.stopwatchState) enum StopwatchState: String { case paused case running static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [ .paused: "Paused", .running: "Running" ] } ``` The schema supports the following system experiences: - Siri - Shortcuts For more information about the App Intents framework and the experiences it supports, see <doc://com.apple.documentation/documentation/appintents/getting-started-with-the-app-intents-framework>.

get · iOS 27.0+

alarmTriggerState

Swift declaration
var alarmTriggerState: some AppSchemaEnum { get }

An enum schema for an alarm trigger state parameter. 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 <doc://com.apple.documentation/documentation/appintents/apple-intelligence-and-siri-ai>. The following example shows an app enum that conforms to the `alarmTriggerState` schema: ```swift @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 <doc://com.apple.documentation/documentation/appintents/getting-started-with-the-app-intents-framework>.

Skipped declarations

No declarations were skipped in this snapshot.

All AppIntents types →