Contents

imageType

An enum schema for an image type parameter.

Declaration

var imageType: 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 video domain and a parameter type matches the imageType schema, you can generate the protocol conformance the schema requires for your app enum implementation with the @AppEnum( .video.imageType) 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 imageType schema:

@AppEnum(schema: .video.imageType)
enum VideoImageType: String {
    case standardPoster
    case widePoster
    case hero
    case headshot
    case logo

    static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [
        .standardPoster: "Standard Poster",
        .widePoster: "Wide Poster",
        .hero: "Hero",
        .headshot: "Headshot",
        .logo: "Logo"
    ]
}

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.

See Also

Types for static parameters