alarm

Declaration

var alarm: some AppSchemaEntity { get }

Discussion

To make your app’s content available to Apple Intelligence, conform your AppEntity to a schema that describes your content to the system. If your app’s functionality aligns with the clock domain and its content matches the alarm schema, you can generate the properties and protocol conformance the schema requires for your app entity implementation with the @AppEntity( .clock.alarm) Swift macro. To make your app work with Siri, see Apple Intelligence and Siri AI.

The following example shows an app entity that conforms to the alarm schema:

@AppEntity(schema: .clock.alarm)
struct AlarmEntity {
    // MARK: Static

    static let defaultQuery = AlarmEntityQuery()

    // MARK: Properties

    let id: <#Identifiable.ID#>

    var time: DateComponents
    var isEnabled: Bool
    var label: String?
    var recurrenceDays: Calendar.RecurrenceRule?
    var canSnooze: Bool
    var triggerState: <#AlarmTriggerState#>

    var displayRepresentation: DisplayRepresentation {
        <#DisplayRepresentation#>
    }

    // MARK: Query

    struct AlarmEntityQuery: EntityQuery {
        func entities(for identifiers: [AlarmEntity.ID]) async throws -> [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

Content and parameter types

• timer
• AppSchema.ClockEntity