Identifies intent schemas in the whiteboard domain.
Members (7)
get · iOS 18.0+
createItem
Swift declaration
var createItem: some AppSchemaIntent { get }
An intent schema that adds an item to a board.
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 `whiteboard` domain
and one of your app's actions matches the `createItem` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .whiteboard.createItem)` 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 `createItem` schema:
```swift
@AppIntent(schema: .whiteboard.createItem)
struct CreateCanvasItemIntent {
var target: <#CanvasEntity#>
var itemType: <#CanvasItemType#>?
var text: AttributedString?
var mediaItems: [IntentFile]
var url: URL?
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+
deleteItem
Swift declaration
var deleteItem: some AppSchemaIntent { get }
An intent schema that deletes the selected canvas items.
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 `whiteboard` domain
and one of your app's actions matches the `deleteItem` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .whiteboard.deleteItem)` 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 `deleteItem` schema:
```swift
@AppIntent(schema: .whiteboard.deleteItem)
struct DeleteCanvasItemIntent: DeleteIntent {
var entities: [<#CanvasItemEntity#>]
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+
updateItem
Swift declaration
var updateItem: some AppSchemaIntent { get }
An intent schema that updates a board item.
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 `whiteboard` domain
and one of your app's actions matches the `updateItem` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .whiteboard.updateItem)` 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 `updateItem` schema:
```swift
@AppIntent(schema: .whiteboard.updateItem)
struct UpdateCanvasItemIntent {
var target: <#CanvasItemEntity#>
var color: <#CanvasColor#>?
var label: 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+
createBoard
Swift declaration
var createBoard: some AppSchemaIntent { get }
An intent schema that creates a new board.
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 `whiteboard` domain
and one of your app's actions matches the `createBoard` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .whiteboard.createBoard)` 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 `createBoard` schema:
```swift
@AppIntent(schema: .whiteboard.createBoard)
struct CreateCanvasBoardIntent {
var title: String?
func perform() async throws -> some ReturnsValue<<#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>.
get · iOS 18.0+
deleteBoard
Swift declaration
var deleteBoard: some AppSchemaIntent { get }
An intent schema that deletes one or more boards.
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 `whiteboard` domain
and one of your app's actions matches the `deleteBoard` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .whiteboard.deleteBoard)` 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 `deleteBoard` schema:
```swift
@AppIntent(schema: .whiteboard.deleteBoard)
struct DeleteCanvasBoardIntent: DeleteIntent {
var entities: [<#CanvasEntity#>]
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+
updateBoard
Swift declaration
var updateBoard: some AppSchemaIntent { get }
An intent schema that renames a board.
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 `whiteboard` domain
and one of your app's actions matches the `updateBoard` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .whiteboard.updateBoard)` 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 `updateBoard` schema:
```swift
@AppIntent(schema: .whiteboard.updateBoard)
struct UpdateCanvasBoardIntent {
var target: <#CanvasEntity#>
var title: 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+
openBoard
Swift declaration
var openBoard: some AppSchemaIntent { get }
An intent schema that opens an existing board.
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 `whiteboard` domain
and one of your app's actions matches the `openBoard` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .whiteboard.openBoard)` 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 `openBoard` schema:
```swift
@AppIntent(schema: .whiteboard.openBoard)
struct OpenCanvasBoardIntent: OpenIntent {
var target: <#CanvasEntity#>
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>.
