Contents

reminder

An entity schema for a reminder.

Declaration

var reminder: 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 reminders domain and its content matches the reminder schema, you can generate the properties and protocol conformance the schema requires for your app entity implementation with the @AppEntity( .reminders.reminder) 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 reminder schema:

@AppEntity(schema: .reminders.reminder)
struct ReminderEntity {
    // MARK: Static

    static let defaultQuery = ReminderEntityQuery()

    // MARK: Properties

    let id: <#Identifiable.ID#>

    var title: String
    var note: AttributedString?
    var images: [IntentFile]
    var subtasks: [<#ReminderEntity#>]
    var tags: Set<String>
    var urls: [URL]
    var dueDate: DateComponents?
    var recurrence: Calendar.RecurrenceRule?
    var isCompleted: Bool
    var isFlagged: Bool?
    var creationDate: Date?
    var completionDate: Date?
    var list: <#ListEntity#>
    var section: <#SectionEntity#>?
    var locationTrigger: <#LocationTriggerEntity#>?

    var displayRepresentation: DisplayRepresentation {
        <#DisplayRepresentation#>
    }

    // MARK: Query

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