An intent schema that creates a new journal entry.
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 `journal` domain
and one of your app's actions matches the `createEntry` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .journal.createEntry)` 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 `createEntry` schema:
```swift
@AppIntent(schema: .journal.createEntry)
struct CreateJournalEntryIntent {
var message: AttributedString
var title: String?
var location: GeoToolbox.PlaceDescriptor?
var mediaItems: [IntentFile]
var entryDate: Date?
func perform() async throws -> some ReturnsValue<<#JournalEntity#>> {
<#code#>
}
}
```
The schema supports the following system experiences:
- 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 18.0+
deleteEntry
Swift declaration
var deleteEntry: some AppSchemaIntent { get }
An intent schema that deletes the specified journal entries.
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 `journal` domain
and one of your app's actions matches the `deleteEntry` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .journal.deleteEntry)` 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 `deleteEntry` schema:
```swift
@AppIntent(schema: .journal.deleteEntry)
struct DeleteJournalEntryIntent: DeleteIntent {
var entities: [<#JournalEntity#>]
func perform() async throws -> some IntentResult {
<#code#>
}
}
```
The schema supports the following system experiences:
- 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 18.0+
updateEntry
Swift declaration
var updateEntry: some AppSchemaIntent { get }
An intent schema that updates journal entry.
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 `journal` domain
and one of your app's actions matches the `updateEntry` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .journal.updateEntry)` 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 `updateEntry` schema:
```swift
@AppIntent(schema: .journal.updateEntry)
struct UpdateJournalEntryIntent {
var target: <#JournalEntity#>
var title: String?
var message: AttributedString?
var mediaItems: [IntentFile]?
var entryDate: Date?
var location: GeoToolbox.PlaceDescriptor?
func perform() async throws -> some IntentResult {
<#code#>
}
}
```
The schema supports the following system experiences:
- 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 18.0+
createAudioEntry
Swift declaration
var createAudioEntry: some AppSchemaIntent { get }
An intent schema that creates a new audio journal entry.
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 `journal` domain
and one of your app's actions matches the `createAudioEntry` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .journal.createAudioEntry)` 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 `createAudioEntry` schema:
```swift
@AppIntent(schema: .journal.createAudioEntry)
struct CreateJournalAudioEntryIntent: AudioStartingIntent {
func perform() async throws -> some IntentResult {
<#code#>
}
}
```
The schema supports the following system experiences:
- 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 18.0+ · Deprecated in iOS 27.0
search
Swift declaration
var search: some AppSchemaIntent { get }
An intent schema that searches journal entries.
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 `journal` domain
and one of your app's actions matches the `search` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .journal.search)` 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 `search` schema:
```swift
@AppIntent(schema: .journal.search)
struct SearchJournalEntriesIntent: ShowInAppSearchResultsIntent {
static var searchScopes: [StringSearchScope] = [.general]
var criteria: StringSearchCriteria
func perform() async throws -> some IntentResult {
<#code#>
}
}
```
The schema supports the following system experiences:
- 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>.
