invocationSource
An enum schema for an invocation source parameter.
Declaration
var invocationSource: some AppSchemaEnum { get }Discussion
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 Apple Intelligence and Siri AI.
The following example shows an app enum that conforms to the invocationSource schema:
@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 Getting started with the App Intents framework.