One Logo Pool Ball
AppIntents · IOS API REFERENCE

AppSchema.ClockIntent

protocol · iOS 27.0+ · SDK 27.1

protocol ClockIntent : AppSchema.Kind

Identifies intent schemas in the clock domain.

Members (14)

get · iOS 27.0+

pauseTimer

Swift declaration
var pauseTimer: some AppSchemaIntent { get }

An intent schema that pauses a timer. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `pauseTimer` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.pauseTimer)` 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 intent that conforms to the `pauseTimer` schema: ```swift @AppIntent(schema: .clock.pauseTimer) struct PauseTimerIntent { var timer: <#TimerEntity#> func perform() async throws -> some IntentResult { <#code#> } } ``` 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+

cancelTimer

Swift declaration
var cancelTimer: some AppSchemaIntent { get }

An intent schema that cancels timers. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `cancelTimer` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.cancelTimer)` 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 intent that conforms to the `cancelTimer` schema: ```swift @AppIntent(schema: .clock.cancelTimer) struct CancelTimerIntent { var entities: [<#TimerEntity#>] func perform() async throws -> some IntentResult { <#code#> } } ``` 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+

createAlarm

Swift declaration
var createAlarm: some AppSchemaIntent { get }

An intent schema that creates an alarm. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `createAlarm` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.createAlarm)` 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 intent that conforms to the `createAlarm` schema: ```swift @AppIntent(schema: .clock.createAlarm) struct CreateAlarmIntent { var time: DateComponents var label: String? var recurrenceDays: Calendar.RecurrenceRule? var canSnooze: Bool func perform() async throws -> some ReturnsValue<<#AlarmEntity#>> { <#code#> } } ``` 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+

createTimer

Swift declaration
var createTimer: some AppSchemaIntent { get }

An intent schema that creates a timer. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `createTimer` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.createTimer)` 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 intent that conforms to the `createTimer` schema: ```swift @AppIntent(schema: .clock.createTimer) struct CreateTimerIntent { var duration: Duration var label: String? var isSleepTimer: Bool func perform() async throws -> some ReturnsValue<<#TimerEntity#>> { <#code#> } } ``` 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+

deleteAlarm

Swift declaration
var deleteAlarm: some AppSchemaIntent { get }

An intent schema that deletes the alarms. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `deleteAlarm` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.deleteAlarm)` 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 intent that conforms to the `deleteAlarm` schema: ```swift @AppIntent(schema: .clock.deleteAlarm) struct DeleteAlarmIntent: DeleteIntent { var entities: [<#AlarmEntity#>] func perform() async throws -> some IntentResult { <#code#> } } ``` 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+

resumeTimer

Swift declaration
var resumeTimer: some AppSchemaIntent { get }

An intent schema that resumes a timer. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `resumeTimer` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.resumeTimer)` 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 intent that conforms to the `resumeTimer` schema: ```swift @AppIntent(schema: .clock.resumeTimer) struct ResumeTimerIntent { var timer: <#TimerEntity#> func perform() async throws -> some IntentResult { <#code#> } } ``` 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+

snoozeAlarm

Swift declaration
var snoozeAlarm: some AppSchemaIntent { get }

An intent schema that snoozes the firing alarm. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `snoozeAlarm` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.snoozeAlarm)` 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 intent that conforms to the `snoozeAlarm` schema: ```swift @AppIntent(schema: .clock.snoozeAlarm) struct SnoozeAlarmIntent { var alarm: <#AlarmEntity#> var duration: Duration func perform() async throws -> some ReturnsValue<<#AlarmEntity#>> { <#code#> } } ``` 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+

updateAlarm

Swift declaration
var updateAlarm: some AppSchemaIntent { get }

An intent schema that updates the alarm, for example, turn on / off the alarm, change the label, time, or repeating schedule. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `updateAlarm` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.updateAlarm)` 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 intent that conforms to the `updateAlarm` schema: ```swift @AppIntent(schema: .clock.updateAlarm) struct UpdateAlarmIntent { var alarm: <#AlarmEntity#> var isEnabled: Bool? var time: DateComponents? var label: String? var recurrenceDays: Calendar.RecurrenceRule? var allowsSnooze: Bool? func perform() async throws -> some ReturnsValue<<#AlarmEntity#>> { <#code#> } } ``` 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+

updateTimer

Swift declaration
var updateTimer: some AppSchemaIntent { get }

An intent schema that updates the timer’s attributes. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `updateTimer` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.updateTimer)` 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 intent that conforms to the `updateTimer` schema: ```swift @AppIntent(schema: .clock.updateTimer) struct UpdateTimerIntent { var timer: <#TimerEntity#> var duration: Duration? var label: String? var isSleepTimer: Bool? func perform() async throws -> some ReturnsValue<<#TimerEntity#>> { <#code#> } } ``` 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+

dismissAlarm

Swift declaration
var dismissAlarm: some AppSchemaIntent { get }

An intent schema that dismisses a firing or snoozed alarm. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `dismissAlarm` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.dismissAlarm)` 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 intent that conforms to the `dismissAlarm` schema: ```swift @AppIntent(schema: .clock.dismissAlarm) struct DismissAlarmIntent { var alarm: <#AlarmEntity#> func perform() async throws -> some ReturnsValue<<#AlarmEntity#>> { <#code#> } } ``` 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+

lapStopwatch

Swift declaration
var lapStopwatch: some AppSchemaIntent { get }

An intent schema that laps the stopwatch. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `lapStopwatch` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.lapStopwatch)` 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 intent that conforms to the `lapStopwatch` schema: ```swift @AppIntent(schema: .clock.lapStopwatch) struct LapStopwatchIntent { var stopwatch: <#StopwatchEntity#> func perform() async throws -> some IntentResult { <#code#> } } ``` 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+

stopStopwatch

Swift declaration
var stopStopwatch: some AppSchemaIntent { get }

An intent schema that stops the stopwatch. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `stopStopwatch` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.stopStopwatch)` 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 intent that conforms to the `stopStopwatch` schema: ```swift @AppIntent(schema: .clock.stopStopwatch) struct StopStopwatchIntent { var stopwatch: <#StopwatchEntity#> func perform() async throws -> some IntentResult { <#code#> } } ``` 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+

resetStopwatch

Swift declaration
var resetStopwatch: some AppSchemaIntent { get }

An intent schema that resets the stopwatch. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `resetStopwatch` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.resetStopwatch)` 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 intent that conforms to the `resetStopwatch` schema: ```swift @AppIntent(schema: .clock.resetStopwatch) struct ResetStopwatchIntent { var stopwatch: <#StopwatchEntity#> func perform() async throws -> some IntentResult { <#code#> } } ``` 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+

startStopwatch

Swift declaration
var startStopwatch: some AppSchemaIntent { get }

An intent schema that starts the stopwatch. To make your app's actions available to Apple Intelligence, conform your ``AppIntent`` to a schema that describes your action to the system. If your app's functionality aligns with the `clock` domain and one of your app's actions matches the `startStopwatch` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .clock.startStopwatch)` 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 intent that conforms to the `startStopwatch` schema: ```swift @AppIntent(schema: .clock.startStopwatch) struct StartStopwatchIntent { func perform() async throws -> some ReturnsValue<<#StopwatchEntity#>> { <#code#> } } ``` 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 →