Contents

personRole

An enum schema for a person role parameter.

Declaration

var personRole: 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 personRole schema, you can generate the protocol conformance the schema requires for your app enum implementation with the @AppEnum( .video.personRole) 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 personRole schema:

@AppEnum(schema: .video.personRole)
enum VideoPersonRole: String {
    case actor
    case director
    case producer
    case writer
    case creator
    case executiveProducer
    case other

    static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [
        .actor: "Actor",
        .director: "Director",
        .producer: "Producer",
        .writer: "Writer",
        .creator: "Creator",
        .executiveProducer: "Executive Producer",
        .other: "Other"
    ]
}

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