createItem

Declaration

var createItem: some AssistantSchemas.Intent { get }

Overview

Use Swift macros that generate additional properties and add protocol conformance for your app intent implementation. The following example shows an app intent that conforms to the .whiteboard.createItem schema:

@AppIntent(schema: .whiteboard.createItem)
struct CreateCanvasItemIntent: AppIntent {
    @Parameter
    var target: CanvasEntity

    @Parameter
    var itemType: CanvasItemType?

    @Parameter
    var text: String?

    @Parameter
    var mediaItems: [IntentFile]

    @Parameter
    var url: URL?

    func perform() async throws -> some ReturnsValue<CanvasItemEntity> {
        .result(value: CanvasItemEntity())
    }
}

For more information about the .whiteboard app intent domain, see doc:Making-whiteboard-actions-available-to-siri-and-apple-intelligence. For general information about app intent domains, see doc:Integrating-actions-with-siri-and-apple-intelligence.