documentKind

Declaration

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

@AppEnum(schema: .reader.documentKind)
enum ReaderDocumentKind: String {
    case <#ReaderDocumentKind Case#>

    static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [
        <#DisplayRepresentations#>
    ]
}

The schema supports the following system experiences:

• 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

• AppSchema.ReaderEnum