Assistant schema conformance for app intents that offer spreadsheet functionality.
Members (14)
get · iOS 16.0+
createSheet
Swift declaration
var createSheet: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for creating a sheet in a spreadsheet.
## 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 `.spreadsheet.createSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.createSheet)
struct CreateSheetIntent: AppIntent {
@Parameter
public var spreadsheet: SpreadsheetEntity
func perform() async throws -> some ReturnsValue<SheetEntity> {
.result(value: SheetEntity())
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
deleteSheet
Swift declaration
var deleteSheet: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for deleting a sheet in a spreadsheet.
## 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 `.spreadsheet.deleteSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.deleteSheet)
struct DeleteSheetIntent: DeleteIntent {
@Parameter var entities: [SheetEntity]
func perform() async throws -> some IntentResult {
.result()
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
updateSheet
Swift declaration
var updateSheet: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for updating a sheet in a spreadsheet.
## 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 `.spreadsheet.updateSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.updateSheet)
struct UpdateSheetIntent: AppIntent {
@Parameter
var target: SheetEntity
@Parameter
var name: String?
@Parameter
var position: Int?
func perform() async throws -> some IntentResult {
.result()
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
addAudioToSheet
Swift declaration
var addAudioToSheet: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for adding audio to a slide.
## 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 `.spreadsheet.addAudioToSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.addAudioToSheet)
struct AddAudioToSheetIntent: AppIntent {
@Parameter
var target: SheetEntity
@Parameter
var audio: IntentFile
func perform() async throws -> some IntentResult {
.result()
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
addImageToSheet
Swift declaration
var addImageToSheet: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for adding an image to a sheet in a spreadsheet.
## 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 `.spreadsheet.addImageToSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.addImageToSheet)
struct AddImageToSheetIntent: AppIntent {
@Parameter
var target: SheetEntity
@Parameter
var audio: IntentFile
func perform() async throws -> some IntentResult {
.result()
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
addVideoToSheet
Swift declaration
var addVideoToSheet: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for adding a video to a sheet in a spreadsheet.
## 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 `.spreadsheet.addVideoToSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.addVideoToSheet)
struct AddVideoToSheetIntent: AppIntent {
@Parameter
var target: SheetEntity
@Parameter
var audio: IntentFile
func perform() async throws -> some IntentResult {
.result()
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
addCommentToSheet
Swift declaration
var addCommentToSheet: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for adding a comment to a sheet in a spreadsheet.
## 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 `.spreadsheet.addCommentToSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.addCommentToSheet)
struct AddCommentToSheetIntent: AppIntent {
@Parameter
var target: SheetEntity
@Parameter
var comment: String?
func perform() async throws -> some IntentResult {
.result()
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
addTextBoxToSheet
Swift declaration
var addTextBoxToSheet: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for adding a textbox to a sheet in a spreadsheet.
## 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 `.spreadsheet.addTextBoxToSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.addTextBoxToSheet)
struct AddTextboxToSheetIntent: AppIntent {
@Parameter
var target: SheetEntity
@Parameter
var text: String
func perform() async throws -> some IntentResult {
.result()
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
addWebVideoToSheet
Swift declaration
var addWebVideoToSheet: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for adding a web video to a sheet in a spreadsheet.
## 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 `.spreadsheet.addWebVideoToSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.addWebVideoToSheet)
struct AddWebVideoToSheetIntent: AppIntent {
@Parameter
var target: SheetEntity
@Parameter
var url: URL
func perform() async throws -> some IntentResult {
.result()
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
open
Swift declaration
var open: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for opening a spreadsheet.
## 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 `.spreadsheet.open` schema:
```swift
@AppIntent(schema: .spreadsheet.open)
struct OpenSpreadsheetIntent: OpenIntent {
@Parameter
var target: SpreadsheetEntity
func perform() async throws -> some IntentResult {
.result()
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
create
Swift declaration
var create: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for creating a spreadsheet.
## 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 `.spreadsheet.create` schema:
```swift
@AppIntent(schema: .spreadsheet.create)
struct CreateSpreadsheetIntent: AppIntent {
@Parameter
var template: SpreadsheetTemplateEntity?
func perform() async throws -> some ReturnsValue<SpreadsheetEntity> {
.result(value: SpreadsheetEntity())
}
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
delete
Swift declaration
var delete: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for deleting a spreadsheet.
## 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 `.spreadsheet.delete` schema:
```swift
@AppIntent(schema: .spreadsheet.delete)
struct DeleteSpreadsheetIntent: DeleteIntent {
@Parameter var entities: [SpreadsheetEntity]
func perform() async throws -> some IntentResult {
.result()
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
update
Swift declaration
var update: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for updating a spreadsheet.
## 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 `.spreadsheet.update` schema:
```swift
@AppIntent(schema: .spreadsheet.update)
struct UpdateSpreadsheetIntent: AppIntent {
@Parameter
var target: SpreadsheetEntity
@Parameter
var name: String?
func perform() async throws -> some IntentResult {
.result()
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
openSheet
Swift declaration
var openSheet: some AssistantSchemas.Intent { get }
The app intent conforms to the schema for opening a sheet in a spreadsheet.
## 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 `.spreadsheet.openSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.openSheet)
struct OpenSheetIntent: OpenIntent {
@Parameter var target: SheetEntity
func perform() async throws -> some IntentResult {
.result()
}
```
For more information about the `.spreadsheet` app intent domain,
see <doc:app-schema-domain-spreadsheet>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
