sheet

Declaration

var sheet: 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 .spreadsheet.sheet schema:

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

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

    let id = UUID()

    @Property
    public var spreadsheet: SpreadsheetEntity

    @Property
    public var name: String

    @Property
    public var sheetIndex: Int

For more information about the .spreadsheet app intent domain, see Making spreadsheet actions available to Siri and Apple Intelligence. For general information about app intent domains, see Integrating actions with Siri and Apple Intelligence.

See Also

Content and parameter types

• document
• template
• AssistantSchemas.SpreadsheetEntity