One Logo Pool Ball
AppIntents · IOS API REFERENCE

AppSchema.CalendarIntent

protocol · iOS 27.0+ · SDK 27.1

protocol CalendarIntent : AppSchema.Kind

Identifies intent schemas in the calendar domain.

Members (3)

get · iOS 27.0+

createEvent

Swift declaration
var createEvent: some AppSchemaIntent { get }

An intent schema that creates a calendar event. 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 <doc://com.apple.documentation/documentation/appintents/apple-intelligence-and-siri-ai>. The following example shows an intent that conforms to the `createEvent` schema: ```swift @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 <doc://com.apple.documentation/documentation/appintents/getting-started-with-the-app-intents-framework>.

get · iOS 27.0+

deleteEvent

Swift declaration
var deleteEvent: some AppSchemaIntent { get }

An intent schema that deletes a calendar event. 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 `deleteEvent` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .calendar.deleteEvent)` Swift macro. To make your app work with Siri, see <doc://com.apple.documentation/documentation/appintents/apple-intelligence-and-siri-ai>. The following example shows an intent that conforms to the `deleteEvent` schema: ```swift @AppIntent(schema: .calendar.deleteEvent) struct DeleteEventIntent { var entity: <#EventEntity#> var span: <#EventSpan#>? func perform() async throws -> some IntentResult { <#code#> } } ``` The schema supports the following system experiences: - Siri - Shortcuts For more information about the App Intents framework and the experiences it supports, see <doc://com.apple.documentation/documentation/appintents/getting-started-with-the-app-intents-framework>.

get · iOS 27.0+

updateEvent

Swift declaration
var updateEvent: some AppSchemaIntent { get }

An intent schema that updates a calendar event. 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 `updateEvent` schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the `@AppIntent( .calendar.updateEvent)` Swift macro. To make your app work with Siri, see <doc://com.apple.documentation/documentation/appintents/apple-intelligence-and-siri-ai>. The following example shows an intent that conforms to the `updateEvent` schema: ```swift @AppIntent(schema: .calendar.updateEvent) struct UpdateEventIntent { var event: <#EventEntity#> var title: String? var attendees: [<#AttendeeEntity#>]? var startDate: Date? var endDate: Date? var isAllDay: Bool? var calendar: <#CalendarEntity#>? var recurrence: Calendar.RecurrenceRule? var note: String? var location: <#EventLocation#>? var span: <#EventSpan#>? 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 <doc://com.apple.documentation/documentation/appintents/getting-started-with-the-app-intents-framework>.

Skipped declarations

No declarations were skipped in this snapshot.

All AppIntents types →