Assistant schema conformance for app intents that offer whiteboard functionality.
Members (7)
get · iOS 16.0+
createItem
Swift declaration
var createItem: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for creating an item on a whiteboard canvas.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app intent implementation. The following example shows an app intent that conforms to the `.whiteboard.createItem` schema:
```swift
@AppIntent(schema: .whiteboard.createItem)
struct CreateCanvasItemIntent: AppIntent {
@Parameter
var target: CanvasEntity
@Parameter
var itemType: CanvasItemType?
@Parameter
var text: String?
@Parameter
var mediaItems: [IntentFile]
@Parameter
var url: URL?
func perform() async throws -> some ReturnsValue<CanvasItemEntity> {
.result(value: CanvasItemEntity())
}
}
```
For more information about the `.whiteboard` app intent domain,
see <doc:app-schema-domain-whiteboard>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
deleteItem
Swift declaration
var deleteItem: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for deleting an item on a whiteboard canvas.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app intent implementation. The following example shows an app intent that conforms to the `.whiteboard.deleteItem` schema:
```swift
@AppIntent(schema: .whiteboard.deleteItem)
struct DeleteCanvasItemIntent: DeleteIntent {
@Parameter
var entities: [CanvasItemEntity]
func perform() async throws -> some IntentResult {
.result()
}
}
```
For more information about the `.whiteboard` app intent domain,
see <doc:app-schema-domain-whiteboard>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
updateItem
Swift declaration
var updateItem: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for updating an item on a whiteboard canvas.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app intent implementation. The following example shows an app intent that conforms to the `.whiteboard.updateItem` schema:
```swift
@AppIntent(schema: .whiteboard.updateItem)
struct UpdateCanvasItemIntent: AppIntent {
@Parameter
var target: CanvasItemEntity
@Parameter
var color: CanvasColor?
@Parameter
var label: String?
func perform() async throws -> some IntentResult {
.result()
}
}
```
For more information about the `.whiteboard` app intent domain,
see <doc:app-schema-domain-whiteboard>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
createBoard
Swift declaration
var createBoard: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for creating a new whiteboard canvas.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app intent implementation. The following example shows an app intent that conforms to the `.whiteboard.createBoard` schema:
```swift
@AppIntent(schema: .whiteboard.createBoard)
struct CreateCanvasBoardIntent: AppIntent {
@Parameter
var title: String?
func perform() async throws -> some ReturnsValue<CanvasEntity> {
.result(value: CanvasEntity())
}
}
```
For more information about the `.whiteboard` app intent domain,
see <doc:app-schema-domain-whiteboard>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
deleteBoard
Swift declaration
var deleteBoard: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for deleting a whiteboard canvas.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app intent implementation. The following example shows an app intent that conforms to the `.whiteboard.deleteBoard` schema:
```swift
@AppIntent(schema: .whiteboard.deleteBoard)
struct DeleteCanvasBoardIntent: DeleteIntent {
@Parameter
var entities: [CanvasEntity]
func perform() async throws -> some IntentResult {
.result()
}
}
```
For more information about the `.whiteboard` app intent domain,
see <doc:app-schema-domain-whiteboard>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
updateBoard
Swift declaration
var updateBoard: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for updating a whiteboard canvas.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app intent implementation. The following example shows an app intent that conforms to the `.whiteboard.updateBoard` schema:
```swift
@AppIntent(schema: .whiteboard.updateBoard)
struct UpdateCanvasBoardIntent: AppIntent {
@Parameter
var target: CanvasEntity
@Parameter
var title: String?
func perform() async throws -> some IntentResult {
.result()
}
}
```
For more information about the `.whiteboard` app intent domain,
see <doc:app-schema-domain-whiteboard>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
openBoard
Swift declaration
var openBoard: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for opening a new whiteboard canvas.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app intent implementation. The following example shows an app intent that conforms to the `.whiteboard.openBoard` schema:
```swift
@AppIntent(schema: .whiteboard.openBoard)
struct OpenCanvasBoardIntent: OpenIntent {
@Parameter
var target: CanvasEntity
func perform() async throws -> some IntentResult {
.result()
}
}
```
For more information about the `.whiteboard` app intent domain,
see <doc:app-schema-domain-whiteboard>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
