An enum schema for an affinity state parameter.
To make your app's parameter types available to Apple Intelligence,
conform your ``AppEnum`` to a schema that describes a parameter's possible values to the system.
If your app's functionality aligns with the `audio` domain
and a parameter type matches the `affinityState` schema,
you can generate the protocol conformance the schema requires
for your app enum implementation
with the `@AppEnum( .audio.affinityState)` 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 app enum that conforms to the `affinityState` schema:
```swift
@AppEnum(schema: .audio.affinityState)
enum AffinityState: String {
case like
case dislike
case unset
static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [
.like: "Like",
.dislike: "Dislike",
.unset: "Unset"
]
}
```
The schema supports the following system experiences:
- Siri
- 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 27.0+
invocationSource
Swift declaration
var invocationSource: some AppSchemaEnum { get }
An enum schema for an invocation source parameter.
To make your app's parameter types available to Apple Intelligence,
conform your ``AppEnum`` to a schema that describes a parameter's possible values to the system.
If your app's functionality aligns with the `audio` domain
and a parameter type matches the `invocationSource` schema,
you can generate the protocol conformance the schema requires
for your app enum implementation
with the `@AppEnum( .audio.invocationSource)` 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 app enum that conforms to the `invocationSource` schema:
```swift
@AppEnum(schema: .audio.invocationSource)
enum InvocationSource: String {
case userInitiated
case suggestedByApp
static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [
.userInitiated: "UserInitiated",
.suggestedByApp: "SuggestedByApp"
]
}
```
The schema supports the following system experiences:
- Siri
- 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 27.0+
appViewIdentifier
Swift declaration
var appViewIdentifier: some AppSchemaEnum { get }
An enum schema for an app view identifier parameter.
To make your app's parameter types available to Apple Intelligence,
conform your ``AppEnum`` to a schema that describes a parameter's possible values to the system.
If your app's functionality aligns with the `audio` domain
and a parameter type matches the `appViewIdentifier` schema,
you can generate the protocol conformance the schema requires
for your app enum implementation
with the `@AppEnum( .audio.appViewIdentifier)` 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 app enum that conforms to the `appViewIdentifier` schema:
```swift
@AppEnum(schema: .audio.appViewIdentifier)
enum AudioAppViewIdentifier: String {
case nowPlaying
static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [
.nowPlaying: "NowPlaying"
]
}
```
The schema supports the following system experiences:
- Siri
- 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 27.0+
playbackAttributes
Swift declaration
var playbackAttributes: some AppSchemaEnum { get }
An enum schema for a playback attributes parameter.
To make your app's parameter types available to Apple Intelligence,
conform your ``AppEnum`` to a schema that describes a parameter's possible values to the system.
If your app's functionality aligns with the `audio` domain
and a parameter type matches the `playbackAttributes` schema,
you can generate the protocol conformance the schema requires
for your app enum implementation
with the `@AppEnum( .audio.playbackAttributes)` 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 app enum that conforms to the `playbackAttributes` schema:
```swift
@AppEnum(schema: .audio.playbackAttributes)
enum PlaybackAttributes: String {
case shuffle
case repeat
static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [
.shuffle: "Shuffle",
.repeat: "Repeat"
]
}
```
The schema supports the following system experiences:
- Siri
- 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 27.0+
queueInsertionLocation
Swift declaration
var queueInsertionLocation: some AppSchemaEnum { get }
An enum schema for a queue insertion location parameter.
To make your app's parameter types available to Apple Intelligence,
conform your ``AppEnum`` to a schema that describes a parameter's possible values to the system.
If your app's functionality aligns with the `audio` domain
and a parameter type matches the `queueInsertionLocation` schema,
you can generate the protocol conformance the schema requires
for your app enum implementation
with the `@AppEnum( .audio.queueInsertionLocation)` 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 app enum that conforms to the `queueInsertionLocation` schema:
```swift
@AppEnum(schema: .audio.queueInsertionLocation)
enum QueueInsertionLocation: String {
case next
case tail
static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [
.next: "Next",
.tail: "Tail"
]
}
```
The schema supports the following system experiences:
- Siri
- 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 27.0+
activity
Swift declaration
var activity: some AppSchemaEnum { get }
An enum schema for an activity parameter.
To make your app's parameter types available to Apple Intelligence,
conform your ``AppEnum`` to a schema that describes a parameter's possible values to the system.
If your app's functionality aligns with the `audio` domain
and a parameter type matches the `activity` schema,
you can generate the protocol conformance the schema requires
for your app enum implementation
with the `@AppEnum( .audio.activity)` 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 app enum that conforms to the `activity` schema:
```swift
@AppEnum(schema: .audio.activity)
enum AudioActivity: String {
case cooking
case dining
case studying
case focusing
case reading
case gaming
case working
case showering
case cleaning
case relaxing
case sleeping
case indoorActivity
case partying
case commuting
case driving
case traveling
case gardening
case barbecuing
case beachDay
case roadTrip
case outdoorActivity
case meditating
case yoga
case walking
case running
case strength
case cycling
case dance
case hiit
case rowing
case workoutLowIntensity
case workoutMediumIntensity
case workoutHighIntensity
static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [
.cooking: "Cooking",
.dining: "Dining",
.studying: "Studying",
.focusing: "Focusing",
.reading: "Reading",
.gaming: "Gaming",
.working: "Working",
.showering: "Showering",
.cleaning: "Cleaning",
.relaxing: "Relaxing",
.sleeping: "Sleeping",
.indoorActivity: "IndoorActivity",
.partying: "Partying",
.commuting: "Commuting",
.driving: "Driving",
.traveling: "Traveling",
.gardening: "Gardening",
.barbecuing: "Barbecuing",
.beachDay: "BeachDay",
.roadTrip: "RoadTrip",
.outdoorActivity: "OutdoorActivity",
.meditating: "Meditating",
.yoga: "Yoga",
.walking: "Walking",
.running: "Running",
.strength: "Strength",
.cycling: "Cycling",
.dance: "Dance",
.hiit: "Hiit",
.rowing: "Rowing",
.workoutLowIntensity: "WorkoutLowIntensity",
.workoutMediumIntensity: "WorkoutMediumIntensity",
.workoutHighIntensity: "WorkoutHighIntensity"
]
}
```
The schema supports the following system experiences:
- Siri
- 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>.
