One Logo Pool Ball
AppIntents · IOS API REFERENCE

AppSchema.SystemIntent

protocol · iOS 18.0+ · SDK 27.1

protocol SystemIntent : AppSchema.Kind

Identifies intent schemas in the system domain.

Members (3)

get · iOS 27.0+

searchInApp

Swift declaration
var searchInApp: some AppSchemaIntent { get }

An intent schema that navigates to search results. 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 `system` domain and one of your app's actions matches the `searchInApp` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .system.searchInApp)` 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 `searchInApp` schema: ```swift @AppIntent(schema: .system.searchInApp) struct SystemSearchInAppIntent: ShowInAppSearchResultsIntent { static var searchScopes: [StringSearchScope] = [.general] var criteria: StringSearchCriteria func perform() async throws -> some IntentResult { <#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+

open

Swift declaration
var open: some AppSchemaIntent { get }

An intent schema that opens an item in the application. 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 `system` domain and one of your app's actions matches the `open` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .system.open)` 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 `open` schema: ```swift @AppIntent(schema: .system.open) struct OpenIntent: OpenIntent { var target: <#any AppEntity#> func perform() async throws -> some IntentResult { <#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 18.0+ · Deprecated in iOS 27.0

search

Swift declaration
var search: some AppSchemaIntent { get }

An intent schema that navigates to search results. 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 `system` 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( .system.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: .system.search) struct ShowInAppSearchResultsIntent: ShowInAppSearchResultsIntent { static var searchScopes: [StringSearchScope] = [.general] var criteria: StringSearchCriteria func perform() async throws -> some IntentResult { <#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 →