Identifies intent schemas in the spreadsheet domain.
Members (14)
get · iOS 18.0+
createSheet
Swift declaration
var createSheet: some AppSchemaIntent { get }
An intent schema that creates a new sheet in a spreadsheet.
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 `spreadsheet` domain
and one of your app's actions matches the `createSheet` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.createSheet)` 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 `createSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.createSheet)
struct CreateSheetIntent {
var spreadsheet: <#SpreadsheetEntity#>
func perform() async throws -> some ReturnsValue<<#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+
deleteSheet
Swift declaration
var deleteSheet: some AppSchemaIntent { get }
An intent schema that deletes sheets in a spreadsheet.
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 `spreadsheet` domain
and one of your app's actions matches the `deleteSheet` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.deleteSheet)` 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 `deleteSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.deleteSheet)
struct DeleteSheetIntent: DeleteIntent {
var entities: [<#SheetEntity#>]
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+
updateSheet
Swift declaration
var updateSheet: some AppSchemaIntent { get }
An intent schema that updates an existing sheet.
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 `spreadsheet` domain
and one of your app's actions matches the `updateSheet` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.updateSheet)` 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 `updateSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.updateSheet)
struct UpdateSheetIntent {
var target: <#SheetEntity#>
var name: String?
var position: Int?
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+
addAudioToSheet
Swift declaration
var addAudioToSheet: some AppSchemaIntent { get }
An intent schema that adds an audio clip to a sheet.
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 `spreadsheet` domain
and one of your app's actions matches the `addAudioToSheet` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.addAudioToSheet)` 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 `addAudioToSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.addAudioToSheet)
struct AddAudioToSheetIntent {
var audio: IntentFile
var target: <#SheetEntity#>
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+
addImageToSheet
Swift declaration
var addImageToSheet: some AppSchemaIntent { get }
An intent schema that adds an image to a sheet.
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 `spreadsheet` domain
and one of your app's actions matches the `addImageToSheet` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.addImageToSheet)` 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 `addImageToSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.addImageToSheet)
struct AddImageToSheetIntent {
var image: IntentFile
var target: <#SheetEntity#>
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+
addVideoToSheet
Swift declaration
var addVideoToSheet: some AppSchemaIntent { get }
An intent schema that adds a video to a sheet.
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 `spreadsheet` domain
and one of your app's actions matches the `addVideoToSheet` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.addVideoToSheet)` 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 `addVideoToSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.addVideoToSheet)
struct AddVideoToSheetIntent {
var video: IntentFile
var target: <#SheetEntity#>
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+
addCommentToSheet
Swift declaration
var addCommentToSheet: some AppSchemaIntent { get }
An intent schema that adds a comment to a sheet.
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 `spreadsheet` domain
and one of your app's actions matches the `addCommentToSheet` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.addCommentToSheet)` 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 `addCommentToSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.addCommentToSheet)
struct AddCommentToSheetIntent {
var comment: String?
var target: <#SheetEntity#>
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+
addTextBoxToSheet
Swift declaration
var addTextBoxToSheet: some AppSchemaIntent { get }
An intent schema that adds text to a sheet.
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 `spreadsheet` domain
and one of your app's actions matches the `addTextBoxToSheet` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.addTextBoxToSheet)` 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 `addTextBoxToSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.addTextBoxToSheet)
struct AddTextboxToSheetIntent {
var text: String
var target: <#SheetEntity#>
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+
addWebVideoToSheet
Swift declaration
var addWebVideoToSheet: some AppSchemaIntent { get }
An intent schema that adds a web video to a sheet.
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 `spreadsheet` domain
and one of your app's actions matches the `addWebVideoToSheet` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.addWebVideoToSheet)` 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 `addWebVideoToSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.addWebVideoToSheet)
struct AddWebVideoToSheetIntent {
var url: URL
var target: <#SheetEntity#>
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+
open
Swift declaration
var open: some AppSchemaIntent { get }
An intent schema that opens the app into an existing spreadsheet.
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 `spreadsheet` domain
and one of your app's actions matches the `open` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.open)` 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 `open` schema:
```swift
@AppIntent(schema: .spreadsheet.open)
struct OpenSpreadsheetIntent: OpenIntent {
var target: <#SpreadsheetEntity#>
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+
create
Swift declaration
var create: some AppSchemaIntent { get }
An intent schema that opens the app for composing a new spreadsheet.
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 `spreadsheet` domain
and one of your app's actions matches the `create` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.create)` 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 `create` schema:
```swift
@AppIntent(schema: .spreadsheet.create)
struct CreateSpreadsheetIntent {
var template: <#SpreadsheetTemplateEntity#>?
func perform() async throws -> some ReturnsValue<<#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+
delete
Swift declaration
var delete: some AppSchemaIntent { get }
An intent schema that deletes existing spreadsheets.
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 `spreadsheet` domain
and one of your app's actions matches the `delete` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.delete)` 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 `delete` schema:
```swift
@AppIntent(schema: .spreadsheet.delete)
struct DeleteSpreadsheetIntent: DeleteIntent {
var entities: [<#SpreadsheetEntity#>]
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+
update
Swift declaration
var update: some AppSchemaIntent { get }
An intent schema that renames an existing spreadsheet.
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 `spreadsheet` domain
and one of your app's actions matches the `update` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.update)` 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 `update` schema:
```swift
@AppIntent(schema: .spreadsheet.update)
struct UpdateSpreadsheetIntent {
var target: <#SpreadsheetEntity#>
var name: 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+
openSheet
Swift declaration
var openSheet: some AppSchemaIntent { get }
An intent schema that opens a sheet.
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 `spreadsheet` domain
and one of your app's actions matches the `openSheet` schema,
you can generate the properties and protocol conformance the schema requires
for your intent implementation
with the `@AppIntent( .spreadsheet.openSheet)` 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 `openSheet` schema:
```swift
@AppIntent(schema: .spreadsheet.openSheet)
struct OpenSheetIntent: OpenIntent {
var target: <#SheetEntity#>
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>.
