One Logo Pool Ball
AppIntents · IOS API REFERENCE

AppSchema.WordProcessorIntent

protocol · iOS 18.0+ · SDK 27.1

protocol WordProcessorIntent : AppSchema.Kind

Identifies intent schemas in the word processor domain.

Members (9)

get · iOS 18.0+

createPage

Swift declaration
var createPage: some AppSchemaIntent { get }

An intent schema that creates a new page in an editor document. 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 `wordProcessor` domain and one of your app's actions matches the `createPage` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .wordProcessor.createPage)` 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 `createPage` schema: ```swift @AppIntent(schema: .wordProcessor.createPage) struct CreateWordProcessorPageIntent { var target: <#WordProcessorDocumentEntity#> var template: String? 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+

addAudioToPage

Swift declaration
var addAudioToPage: some AppSchemaIntent { get }

An intent schema that adds an audio clip to a 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 `wordProcessor` domain and one of your app's actions matches the `addAudioToPage` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .wordProcessor.addAudioToPage)` 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 `addAudioToPage` schema: ```swift @AppIntent(schema: .wordProcessor.addAudioToPage) struct AddAudioToWordProcessorPageIntent { var audio: IntentFile var target: <#WordProcessorPageEntity#> 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+

addImageToPage

Swift declaration
var addImageToPage: some AppSchemaIntent { get }

An intent schema that adds an image to a 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 `wordProcessor` domain and one of your app's actions matches the `addImageToPage` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .wordProcessor.addImageToPage)` 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 `addImageToPage` schema: ```swift @AppIntent(schema: .wordProcessor.addImageToPage) struct AddImageToWordProcessorPageIntent { var image: IntentFile var target: <#WordProcessorPageEntity#> 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+

addVideoToPage

Swift declaration
var addVideoToPage: some AppSchemaIntent { get }

An intent schema that adds a video to a 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 `wordProcessor` domain and one of your app's actions matches the `addVideoToPage` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .wordProcessor.addVideoToPage)` 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 `addVideoToPage` schema: ```swift @AppIntent(schema: .wordProcessor.addVideoToPage) struct AddVideoToWordProcessorPageIntent { var video: IntentFile var target: <#WordProcessorPageEntity#> 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+

addTextBoxToPage

Swift declaration
var addTextBoxToPage: some AppSchemaIntent { get }

An intent schema that adds a textbox to a 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 `wordProcessor` domain and one of your app's actions matches the `addTextBoxToPage` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .wordProcessor.addTextBoxToPage)` 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 `addTextBoxToPage` schema: ```swift @AppIntent(schema: .wordProcessor.addTextBoxToPage) struct AddTextBoxToWordProcessorPageIntent { var text: String var target: <#WordProcessorPageEntity#> 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+

addWebVideoToPage

Swift declaration
var addWebVideoToPage: some AppSchemaIntent { get }

An intent schema that adds a web video to a 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 `wordProcessor` domain and one of your app's actions matches the `addWebVideoToPage` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .wordProcessor.addWebVideoToPage)` 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 `addWebVideoToPage` schema: ```swift @AppIntent(schema: .wordProcessor.addWebVideoToPage) struct AddWebVideoToWordProcessorPageIntent { var url: URL var target: <#WordProcessorPageEntity#> 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+

open

Swift declaration
var open: some AppSchemaIntent { get }

An intent schema that opens the app to an editor. 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 `wordProcessor` 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( .wordProcessor.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: .wordProcessor.open) struct OpenWordProcessorDocumentIntent: OpenIntent { var target: <#WordProcessorDocumentEntity#> 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+

create

Swift declaration
var create: some AppSchemaIntent { get }

An intent schema that opens the app for composing a new text document. 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 `wordProcessor` domain and one of your app's actions matches the `create` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .wordProcessor.create)` 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 `create` schema: ```swift @AppIntent(schema: .wordProcessor.create) struct CreateWordProcessorDocumentIntent { var template: <#WordProcessorDocumentTemplateEntity#>? 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 an editor 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 `wordProcessor` 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( .wordProcessor.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: .wordProcessor.openPage) struct OpenWordProcessorPageIntent: OpenIntent { var target: <#WordProcessorPageEntity#> 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 →