One Logo Pool Ball
AppIntents · IOS API REFERENCE

AppSchema.NotesIntent

protocol · iOS 27.0+ · SDK 27.1

protocol NotesIntent : AppSchema.Kind

Identifies intent schemas in the notes domain.

Members (3)

get · iOS 27.0+

appendText

Swift declaration
var appendText: some AppSchemaIntent { get }

An intent schema that adds text to the end of an existing note. 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 `notes` domain and one of your app's actions matches the `appendText` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .notes.appendText)` 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 `appendText` schema: ```swift @AppIntent(schema: .notes.appendText) struct NoteAppendTextIntent { var content: AttributedString var target: <#NoteEntity#> func perform() async throws -> some ReturnsValue<<#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 <doc://com.apple.documentation/documentation/appintents/getting-started-with-the-app-intents-framework>.

get · iOS 27.0+

createNote

Swift declaration
var createNote: some AppSchemaIntent { get }

An intent schema that creates a new note. 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 `notes` domain and one of your app's actions matches the `createNote` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .notes.createNote)` 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 `createNote` schema: ```swift @AppIntent(schema: .notes.createNote) struct CreateNoteIntent { var name: AttributedString var content: AttributedString? var attachments: [IntentFile] var isPinned: Bool var folder: <#FolderEntity#>? func perform() async throws -> some ReturnsValue<<#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 <doc://com.apple.documentation/documentation/appintents/getting-started-with-the-app-intents-framework>.

get · iOS 27.0+

updateNote

Swift declaration
var updateNote: some AppSchemaIntent { get }

An intent schema that updates a note. 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 `notes` domain and one of your app's actions matches the `updateNote` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .notes.updateNote)` 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 `updateNote` schema: ```swift @AppIntent(schema: .notes.updateNote) struct UpdateNoteIntent { var target: <#NoteEntity#> var name: AttributedString? var attachments: [IntentFile]? var isPinned: Bool? var folder: <#FolderEntity#>? func perform() async throws -> some ReturnsValue<<#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 <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 →