Contents

dismissAlarm

An intent schema that dismisses a firing or snoozed alarm.

Declaration

var dismissAlarm: some AppSchemaIntent { get }

Discussion

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 Apple Intelligence and Siri AI.

The following example shows an intent that conforms to the dismissAlarm schema:

@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 Getting started with the App Intents framework.

See Also

Actions