Identifies entity schemas in the word processor domain.
Members (3)
get · iOS 18.0+
page
Swift declaration
var page: some AppSchemaEntity { get }
An entity schema for a page.
To make your app's content available to Apple Intelligence,
conform your ``AppEntity`` to a schema that describes your content to the system.
If your app's functionality aligns with the `wordProcessor` domain
and its content matches the `page` schema,
you can generate the properties and protocol conformance the schema requires
for your app entity implementation
with the `@AppEntity( .wordProcessor.page)` 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 app entity that conforms to the `page` schema:
```swift
@AppEntity(schema: .wordProcessor.page)
struct WordProcessorPageEntity {
// MARK: Static
static let defaultQuery = WordProcessorPageEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var document: <#WordProcessorDocumentEntity#>
var pageIndex: Int
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct WordProcessorPageEntityQuery: EntityQuery {
func entities(for identifiers: [WordProcessorPageEntity.ID]) async throws -> [WordProcessorPageEntity] {
<#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+
document
Swift declaration
var document: some AppSchemaEntity { get }
An entity schema for a document.
To make your app's content available to Apple Intelligence,
conform your ``AppEntity`` to a schema that describes your content to the system.
If your app's functionality aligns with the `wordProcessor` domain
and its content matches the `document` schema,
you can generate the properties and protocol conformance the schema requires
for your app entity implementation
with the `@AppEntity( .wordProcessor.document)` 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 app entity that conforms to the `document` schema:
```swift
@AppEntity(schema: .wordProcessor.document)
struct WordProcessorDocumentEntity {
// MARK: Static
static let defaultQuery = WordProcessorDocumentEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var name: String
var creationDate: Date?
var modificationDate: Date?
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct WordProcessorDocumentEntityQuery: EntityQuery {
func entities(for identifiers: [WordProcessorDocumentEntity.ID]) async throws -> [WordProcessorDocumentEntity] {
<#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+
template
Swift declaration
var template: some AppSchemaEntity { get }
An entity schema for a template.
To make your app's content available to Apple Intelligence,
conform your ``AppEntity`` to a schema that describes your content to the system.
If your app's functionality aligns with the `wordProcessor` domain
and its content matches the `template` schema,
you can generate the properties and protocol conformance the schema requires
for your app entity implementation
with the `@AppEntity( .wordProcessor.template)` 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 app entity that conforms to the `template` schema:
```swift
@AppEntity(schema: .wordProcessor.template)
struct WordProcessorDocumentTemplateEntity {
// MARK: Static
static let defaultQuery = WordProcessorDocumentTemplateEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var name: String
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct WordProcessorDocumentTemplateEntityQuery: EntityQuery {
func entities(for identifiers: [WordProcessorDocumentTemplateEntity.ID]) async throws -> [WordProcessorDocumentTemplateEntity] {
<#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>.
