App entities
Make your app’s core types and data concepts available to the system using app entity types.
Overview
App entities provide the system with information about your app’s data, or about concepts related to your app’s data. App entities help the system resolve parameters for app intents by letting it introspect relevant types. For example, a photo app that provides app entities for its photos and albums might also provide app entities to represent “the current photo” or “this album.” These specific app entities help resolve intents more quickly and with fewer verbal interactions.
Define app entities for core types and concepts that you want to make available to system experiences. Add properties for any data values that help people discover entities using queries. For example, add the name of a photo album or the currency amount for a financial transaction.
Topics
Essentials
App entity types
AppEntityFileEntityIndexedEntitySyncableEntityTransientAppEntityUniqueAppEntityOwnershipProvidingEntityUnionValue()AppUnionValueAppUnionValueCasesProviding
Entity collections
Entity identity
EntityIdentifierEntityIdentifierConvertibleFileEntityIdentifierPersistentlyIdentifiableSyncableEntityIdentifierAttributedEntityIdentifierAttributedTypeIdentifierAppEntityAnnotatableAppEntityIdentifier
Entity queries
Property declarations
ComputedProperty()ComputedProperty(title:)ComputedProperty(indexingKey:)ComputedProperty(customIndexingKey:)ComputedProperty(title:customIndexingKey:)ComputedProperty(title:indexingKey:)DeferredProperty()DeferredProperty(title:)DeferredProperty(indexingKey:)DeferredProperty(title:indexingKey:)EntityPropertyEntityPropertyModifiersProperty comparators
Data representations
DisplayRepresentationDisplayRepresentableInstanceDisplayRepresentableTypeDisplayRepresentableTypeDisplayRepresentationStaticDisplayRepresentableCaseDisplayRepresentable