album

Declaration

var album: 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 .photos.album schema:

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

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

    let id = UUID()

    @Property
    var name: String

    @Property
    var creationDate: Date?

    @Property
    var albumType: PhotoAlbumType
}

For more information about the .photos app intent domain, see Making photo and video 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

• asset
• recognizedPerson
• AssistantSchemas.PhotosEntity