Identifies entity schemas in the whiteboard domain.
Members (2)
get · iOS 18.0+
item
Swift declaration
var item: some AppSchemaEntity { get }
An entity schema for an item.
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 `whiteboard` domain
and its content matches the `item` schema,
you can generate the properties and protocol conformance the schema requires
for your app entity implementation
with the `@AppEntity( .whiteboard.item)` 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 `item` schema:
```swift
@AppEntity(schema: .whiteboard.item)
struct CanvasItemEntity {
// MARK: Static
static let defaultQuery = CanvasItemEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var type: <#CanvasItemType#>
var label: String?
var x: Double
var y: Double
var width: Double?
var height: Double?
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct CanvasItemEntityQuery: EntityQuery {
func entities(for identifiers: [CanvasItemEntity.ID]) async throws -> [CanvasItemEntity] {
<#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+
board
Swift declaration
var board: some AppSchemaEntity { get }
An entity schema for a board.
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 `whiteboard` domain
and its content matches the `board` schema,
you can generate the properties and protocol conformance the schema requires
for your app entity implementation
with the `@AppEntity( .whiteboard.board)` 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 `board` schema:
```swift
@AppEntity(schema: .whiteboard.board)
struct CanvasEntity {
// MARK: Static
static let defaultQuery = CanvasEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var title: String
var creationDate: Date
var lastModificationDate: Date
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct CanvasEntityQuery: EntityQuery {
func entities(for identifiers: [CanvasEntity.ID]) async throws -> [CanvasEntity] {
<#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>.
