Identifies entity schemas in the spreadsheet domain.
Members (3)
get · iOS 18.0+
sheet
Swift declaration
var sheet: some AppSchemaEntity { get }
An entity schema for a sheet.
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 `spreadsheet` domain
and its content matches the `sheet` schema,
you can generate the properties and protocol conformance the schema requires
for your app entity implementation
with the `@AppEntity( .spreadsheet.sheet)` 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 `sheet` schema:
```swift
@AppEntity(schema: .spreadsheet.sheet)
struct SheetEntity {
// MARK: Static
static let defaultQuery = SheetEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var name: String
var sheetIndex: Int
var spreadsheet: <#SpreadsheetEntity#>
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct SheetEntityQuery: EntityQuery {
func entities(for identifiers: [SheetEntity.ID]) async throws -> [SheetEntity] {
<#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 `spreadsheet` 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( .spreadsheet.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: .spreadsheet.document)
struct SpreadsheetEntity {
// MARK: Static
static let defaultQuery = SpreadsheetEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var name: String
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct SpreadsheetEntityQuery: EntityQuery {
func entities(for identifiers: [SpreadsheetEntity.ID]) async throws -> [SpreadsheetEntity] {
<#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 `spreadsheet` 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( .spreadsheet.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: .spreadsheet.template)
struct SpreadsheetTemplateEntity {
// MARK: Static
static let defaultQuery = SpreadsheetTemplateEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var name: String
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct SpreadsheetTemplateEntityQuery: EntityQuery {
func entities(for identifiers: [SpreadsheetTemplateEntity.ID]) async throws -> [SpreadsheetTemplateEntity] {
<#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>.
