One Logo Pool Ball
AppIntents · IOS API REFERENCE

AppSchema.ReaderIntent

protocol · iOS 18.0+ · SDK 27.1

protocol ReaderIntent : AppSchema.Kind

Identifies intent schemas in the reader domain.

Members (9)

get · iOS 18.0+

deletePages

Swift declaration
var deletePages: some AppSchemaIntent { get }

An intent schema that deletes the specified pages. 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 `reader` domain and one of your app's actions matches the `deletePages` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .reader.deletePages)` 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 `deletePages` schema: ```swift @AppIntent(schema: .reader.deletePages) struct ReaderDeletePagesIntent: DeleteIntent { var entities: [<#ReaderPageEntity#>] 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+

insertPages

Swift declaration
var insertPages: some AppSchemaIntent { get }

An intent schema that inserts pages from the specified files. 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 `reader` domain and one of your app's actions matches the `insertPages` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .reader.insertPages)` 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 `insertPages` schema: ```swift @AppIntent(schema: .reader.insertPages) struct ReaderInsertPagesIntent { var files: [IntentFile] var isAfter: Bool var page: <#ReaderPageEntity#> 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+

rotatePages

Swift declaration
var rotatePages: some AppSchemaIntent { get }

An intent schema that rotates the pages in the specified direction. 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 `reader` domain and one of your app's actions matches the `rotatePages` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .reader.rotatePages)` 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 `rotatePages` schema: ```swift @AppIntent(schema: .reader.rotatePages) struct ReaderRotatePagesIntent { var pages: [<#ReaderPageEntity#>] var isClockwise: Bool 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+

openDocument

Swift declaration
var openDocument: some AppSchemaIntent { get }

An intent schema that opens the specified files in the reader. 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 `reader` domain and one of your app's actions matches the `openDocument` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .reader.openDocument)` 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 `openDocument` schema: ```swift @AppIntent(schema: .reader.openDocument) struct ReaderOpenDocumentsIntent { var files: [IntentFile] 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+

resizeDocuments

Swift declaration
var resizeDocuments: some AppSchemaIntent { get }

An intent schema that resizes the documents to a particular width and height. 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 `reader` domain and one of your app's actions matches the `resizeDocuments` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .reader.resizeDocuments)` 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 `resizeDocuments` schema: ```swift @AppIntent(schema: .reader.resizeDocuments) struct ReaderResizeDocumentsIntent { var documents: [<#ReaderDocumentEntity#>] var width: Double? var height: Double? 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+

rotateDocuments

Swift declaration
var rotateDocuments: some AppSchemaIntent { get }

An intent schema that rotates the documents in the specified direction. 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 `reader` domain and one of your app's actions matches the `rotateDocuments` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .reader.rotateDocuments)` 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 `rotateDocuments` schema: ```swift @AppIntent(schema: .reader.rotateDocuments) struct ReaderRotateDocumentsIntent { var documents: [<#ReaderDocumentEntity#>] var isClockwise: Bool 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+

searchDocuments

Swift declaration
var searchDocuments: some AppSchemaIntent { get }

An intent schema that searches for text in the documents. 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 `reader` domain and one of your app's actions matches the `searchDocuments` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .reader.searchDocuments)` 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 `searchDocuments` schema: ```swift @AppIntent(schema: .reader.searchDocuments) struct SearchReaderDocumentsIntent { var criteria: String var documents: [<#ReaderDocumentEntity#>] 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+

enhanceDocuments

Swift declaration
var enhanceDocuments: some AppSchemaIntent { get }

An intent schema that enhances the documents. 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 `reader` domain and one of your app's actions matches the `enhanceDocuments` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .reader.enhanceDocuments)` 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 `enhanceDocuments` schema: ```swift @AppIntent(schema: .reader.enhanceDocuments) struct ReaderEnhanceDocumentsIntent { var target: [<#ReaderDocumentEntity#>] 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+

openPage

Swift declaration
var openPage: some AppSchemaIntent { get }

An intent schema that opens the app to the specified document page. 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 `reader` domain and one of your app's actions matches the `openPage` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .reader.openPage)` 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 `openPage` schema: ```swift @AppIntent(schema: .reader.openPage) struct ReaderOpenPageIntent: OpenIntent { var target: <#ReaderPageEntity#> 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>.

Skipped declarations

No declarations were skipped in this snapshot.

All AppIntents types →