note
An entity schema for a note.
Declaration
var note: 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 notes domain and its content matches the note schema, you can generate the properties and protocol conformance the schema requires for your app entity implementation with the @AppEntity( .notes.note) 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 note schema:
@AppEntity(schema: .notes.note)
struct NoteEntity {
// MARK: Static
static let defaultQuery = NoteEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var name: AttributedString
var content: AttributedString?
var attachments: [IntentFile]
var tags: [<#TagEntity#>]
var isPinned: Bool
var creationDate: Date?
var modificationDate: Date?
var folder: <#FolderEntity#>?
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct NoteEntityQuery: EntityQuery {
func entities(for identifiers: [NoteEntity.ID]) async throws -> [NoteEntity] {
<#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.