Contents

board

The app entity describes a whiteboard canvas.

Declaration

var board: some AssistantSchemas.Entity { get }

Overview

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

@AppEntity(schema: .whiteboard.board)
struct CanvasEntity: AppEntity {
    struct Query: EntityStringQuery {
        func entities(for identifiers: [CanvasEntity.ID]) async throws -> [CanvasEntity] { [] }
        func entities(matching string: String) async throws -> [CanvasEntity] { [] }
    }

    static var defaultQuery = Query()
    var displayRepresentation: DisplayRepresentation { "Canvas" }

    let id = UUID()

    @Property
    var title: String

    @Property
    var creationDate: Date

    @Property
    var lastModificationDate: Date
}

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.