Contents

createEvent

An intent schema that creates a calendar event.

Declaration

var createEvent: some AppSchemaIntent { get }

Discussion

To make your app’s actions available to Apple Intelligence, conform your AppIntent to a schema that describes your action to the system. If your app’s functionality aligns with the calendar domain and one of your app’s actions matches the createEvent schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the @AppIntent( .calendar.createEvent) Swift macro. To make your app work with Siri, see Apple Intelligence and Siri AI.

The following example shows an intent that conforms to the createEvent schema:

@AppIntent(schema: .calendar.createEvent)
struct CreateEventIntent {
    var title: String
    var startDate: Date
    var endDate: Date?
    var location: <#EventLocation#>?
    var calendar: <#CalendarEntity#>
    var isAllDay: Bool
    var recurrence: Calendar.RecurrenceRule?
    var attendees: [<#AttendeeEntity#>]
    var note: AttributedString?

    func perform() async throws -> some ReturnsValue<<#EventEntity#>> {
        <#code#>
    }
}

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

Actions