Contents

eventSpan

An enum schema for an event span parameter.

Declaration

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

@AppEnum(schema: .calendar.eventSpan)
enum EventSpan: String {
    case this
    case future
    case all

    static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [
        .this: "This",
        .future: "Future",
        .all: "All"
    ]
}

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