Assistant schema conformance for types you use to describe ebooks or audiobooks.
Members (10)
get · iOS 16.0+
contentType
Swift declaration
var contentType: some AssistantSchemas.Enum { get }
The content type.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app enum implementation. The following example shows an app enum that conforms to the `.books.contentType` schema:
```swift
@AppEnum(schema: .books.contentType)
enum BookContentType: AppEnum {
case book
case pdf
static var caseDisplayRepresentations: [BookContentType: AppIntents.DisplayRepresentation] = [
.book: "Book",
.pdf: "PDF",
]
}
For more information about the `.books` app intent domain,
see <doc:app-schema-domain-books>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
```
get · iOS 16.0+
relativeFontChange
Swift declaration
var relativeFontChange: some AssistantSchemas.Enum { get }
The relative change of the font for rendering a book.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app enum implementation. The following example shows an app enum that conforms to the `.books.relativeFontChange` schema:
```swift
@AppEnum(schema: .books.relativeFontChange)
enum BookRelativeFontChange: AppEnum {
case increase
case decrease
static var caseDisplayRepresentations: [BookRelativeFontChange: AppIntents.DisplayRepresentation] = [
.increase: "Increase",
.decrease: "Decrease",
]
}
```
For more information about the `.books` app intent domain,
see <doc:app-schema-domain-books>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
navigationDirection
Swift declaration
var navigationDirection: some AssistantSchemas.Enum { get }
The navigation direction of a book.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app enum implementation. The following example shows an app enum that conforms to the `.books.navigationDirection` schema:
```swift
@AppEnum(schema: .books.navigationDirection)
enum BookNavigationDirection: AppEnum {
case next
case previous
static var caseDisplayRepresentations: [BookNavigationDirection: AppIntents.DisplayRepresentation] = [
.next: "Next",
.previous: "Previous",
]
}
```
For more information about the `.books` app intent domain,
see <doc:app-schema-domain-books>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
pageNavigationSetting
Swift declaration
var pageNavigationSetting: some AssistantSchemas.Enum { get }
Navigation settings for rendering a book.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app enum implementation. The following example shows an app enum that conforms to the `.books.pageNavigationSetting` schema:
```swift
@AppEnum(schema: .books.pageNavigationSetting)
enum BookPageNavigationSetting: AppEnum {
case continuousScroll
case pageTurning
static var caseDisplayRepresentations: [BookPageNavigationSetting: AppIntents.DisplayRepresentation] = [
.continuousScroll: "Continuous Scroll",
.pageTurning: "Page Turning",
]
}
```
For more information about the `.books` app intent domain,
see <doc:app-schema-domain-books>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
relativeLineSpacingChange
Swift declaration
var relativeLineSpacingChange: some AssistantSchemas.Enum { get }
The relative change in line spacing for rendering a book.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app enum implementation. The following example shows an app enum that conforms to the `.books.relativeLineSpacingChange` schema:
```swift
@AppEnum(schema: .books.relativeLineSpacingChange)
enum BookRelativeLineSpacingChange: AppEnum {
case `default`
static var caseDisplayRepresentations: [BookRelativeLineSpacingChange: AppIntents.DisplayRepresentation] = [
.`default`: "Default"
]
}
```
For more information about the `.books` app intent domain,
see <doc:app-schema-domain-books>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
relativeWordSpacingChange
Swift declaration
var relativeWordSpacingChange: some AssistantSchemas.Enum { get }
The relative change in word spacing for rendering a book.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app enum implementation. The following example shows an app enum that conforms to
the `.books.relativeWordSpacingChange` schema:
```swift
@AppEnum(schema: .books.relativeWordSpacingChange)
enum BookRelativeWordSpacingChange: AppEnum {
case small
case large
static var caseDisplayRepresentations: [BookRelativeWordSpacingChange: AppIntents.DisplayRepresentation] = [
.small: "Increase",
.large: "Decrease",
]
}
```
For more information about the `.books` app intent domain,
see <doc:app-schema-domain-books>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
relativeCharacterSpacingChange
Swift declaration
var relativeCharacterSpacingChange: some AssistantSchemas.Enum { get }
The relative change in character spacing for rendering a book.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app enum implementation. The following example shows an app enum that conforms to the
`.books.relativeCharacterSpacingChange` schema:
```swift
@AppEnum(schema: .books.relativeCharacterSpacingChange)
enum BookRelativeCharacterSpacingChange: AppEnum {
case reset
static var caseDisplayRepresentations: [BookRelativeCharacterSpacingChange: AppIntents.DisplayRepresentation] = [
.reset: "Reset"
]
}
```
For more information about the `.books` app intent domain,
see <doc:app-schema-domain-books>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
font
Swift declaration
var font: some AssistantSchemas.Enum { get }
The font for rendering a book.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app enum implementation. The following example shows an app enum that conforms to the `.books.font` schema:
```swift
@AppEnum(schema: .books.font)
enum BookFont: AppEnum {
case `default`
static var caseDisplayRepresentations: [BookFont: AppIntents.DisplayRepresentation] = [
.`default`: "Default",
]
}
```
For more information about the `.books` app intent domain,
see <doc:app-schema-domain-books>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
theme
Swift declaration
var theme: some AssistantSchemas.Enum { get }
The theme for rendering a book.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app enum implementation.
The following example shows an app enum that conforms to the `.books.theme` schema:
```swift
@AppEnum(schema: .books.theme)
enum BookTheme: AppEnum {
case lightMode
case darkMode
case theme1
static var caseDisplayRepresentations: [BookTheme: AppIntents.DisplayRepresentation] = [
.lightMode: "Light Mode",
.darkMode: "Dark Mode",
.theme1: "Theme 1",
]
}
```
For more information about the `.books` app intent domain,
see <doc:app-schema-domain-books>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
get · iOS 16.0+
fontSize
Swift declaration
var fontSize: some AssistantSchemas.Enum { get }
The font size for rendering a book.
## Overview
Use Swift macros that generate additional properties and add protocol conformance
for your app enum implementation. The following example shows an app enum that conforms to the `.books.fontSize` schema:
```swift
@AppEnum(schema: .books.fontSize)
enum BookFontSize: AppEnum {
case `default`
static var caseDisplayRepresentations: [BookFontSize: AppIntents.DisplayRepresentation] = [
.`default`: "Default",
]
}
```
For more information about the `.books` app intent domain,
see <doc:app-schema-domain-books>.
For general information about app intent domains, see <doc:making-actions-and-content-discoverable-by-apple-intelligence>.
