customAttachment

An entity schema for a custom attachment.

Declaration

var customAttachment: some AppSchemaEntity { get }

Discussion

To make your app’s content available to Apple Intelligence, conform your AppEntity to a schema that describes your content to the system. If your app’s functionality aligns with the messages domain and its content matches the customAttachment schema, you can generate the properties and protocol conformance the schema requires for your app entity implementation with the @AppEntity( .messages.customAttachment) Swift macro. To make your app work with Siri, see Apple Intelligence and Siri AI.

The following example shows an app entity that conforms to the customAttachment schema:

@AppEntity(schema: .messages.customAttachment)
struct CustomAttachment {
    // MARK: Static

    static let defaultQuery = CustomAttachmentQuery()

    // MARK: Properties

    let id: <#Identifiable.ID#>

    var sourceName: AttributedString?
    var description: AttributedString?

    var displayRepresentation: DisplayRepresentation {
        <#DisplayRepresentation#>
    }

    // MARK: Query

    struct CustomAttachmentQuery: EntityQuery {
        func entities(for identifiers: [CustomAttachment.ID]) async throws -> [CustomAttachment] {
            <#code#>
        }
    }
}

The schema supports the following system experiences:

Siri
Shortcuts

For more information about the App Intents framework and the experiences it supports, see Getting started with the App Intents framework.

customAttachment

Declaration

Discussion

See Also

Content and parameter types