search

Declaration

var search: some AppSchemaIntent { get }

Discussion

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 Apple Intelligence and Siri AI.

The following example shows an intent that conforms to the search schema:

@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 Getting started with the App Intents framework.