indexAppEntities(_:priority:)
Indexes one or more app entities and assigns an optional priority to them.
Declaration
func indexAppEntities(_ appEntities: [some IndexedEntity], priority: Int = 0) async throwsParameters
- appEntities:
One or more app entities you want to donate to Spotlight. Each entity must conform to the Indexedentity protocol.
- priority:
The importance of these donated items relative to your app’s other items. If you don’t specify a priority, this method assigns a priority of 0 to the items. Specify a higher number to prioritize the entities over other items you add to the index. The App Intents system uses priorities to determine what items to show in suggestions and other places.
Discussion
Use this method to index the AppEntity instances you create for your app’s content. For each object in appEntities, Spotlight identifies the indexable content and adds it to your app’s index. However, the indexing process isn’t recursive, and this method doesn’t index any child entities contained inside your entity objects. To index both parent and child entities, you must add each object separately to the appEntities parameter.
Indexing your app’s entities has some specific benefits. If your app also provides OpenIntent types for its entities, Spotlight can use those types to open your app and display an entity’s content when someone selects it in search results.
Call this method as an alternative to creating and indexing CSSearchableItem types for your content. If you index a searchable item and entity for the same content, Spotlight creates separate entries for each one in your app’s index. If you want to use your existing code to create searchable items, you can call the associateAppEntity(_:priority:) method to associate an entity with each of your items. Doing so gives you the same benefits as indexing the entity on its own, without creating multiple entries for the item in the app’s index.