How to open app when indexed entity is tapped?

Generated on 8/7/2024

1 search

To open an app when an indexed entity is tapped, you can follow these steps:

  1. Conform to the IndexedEntity Protocol: First, ensure your entity conforms to the IndexedEntity protocol. This allows your app's entities to be indexed in Spotlight.

  2. Index Your Entities: In your app's initialization method, index your entities using CSSearchableIndex. This makes your entities searchable in Spotlight.

  3. Create an Intent: Define an intent that can handle the action of opening the entity. For example, you can create an OpenTrailIntent that accepts a TrailEntity as a parameter.

  4. Implement the Intent: Ensure your intent navigates to the appropriate content within your app. This involves updating the perform method to handle the navigation.

  5. Associate the Entity with Searchable Items: If you are already using the CSSearchableItem API, you can associate your app entity with the searchable item using the associateAppEntity method.

Here is a more detailed breakdown from the sessions:

  • In the session What’s new in App Intents, it is demonstrated how to add support for indexed entities and how to use the CSSearchableIndex to index your entities. This allows the entities to show up in Spotlight search results.

  • The session Bring your app to Siri shows how to create an intent that can open a specific entity in your app. This involves defining an intent that accepts the entity as a parameter and implementing the necessary navigation logic.

  • Additionally, the session Bring your app’s core features to users with App Intents explains how to define entities and intents, ensuring they are meaningful and properly integrated with your app's navigation.

By following these steps and utilizing the new APIs introduced at WWDC, you can enable your app to open directly to the relevant content when an indexed entity is tapped in Spotlight.

Bring your app’s core features to users with App Intents

Bring your app’s core features to users with App Intents

Learn the principles of the App Intents framework, like intents, entities, and queries, and how you can harness them to expose your app’s most important functionality right where people need it most. Find out how to build deep integration between your app and the many system features built on top of App Intents, including Siri, controls and widgets, Apple Pencil, Shortcuts, the Action button, and more. Get tips on how to build your App Intents integrations efficiently to create the best experiences in every surface while still sharing code and core functionality.

What’s new in App Intents

What’s new in App Intents

Learn about improvements and all-new features with App Intents, and discover how this framework can help you expose your app’s functionality to Siri, Spotlight, Shortcuts, and more. We’ll show you how to make your entities more meaningful to the platform with the Transferable API, File Representations, new IntentFile APIs, and Spotlight Indexing, opening up powerful functionality in Siri and the Shortcuts app. Empower your intents to take people deep into your app with URL Representable Entities. Explore new techniques to model your entities and intents with new APIs for error handling and union values.

Bring your app to Siri

Bring your app to Siri

Learn how to use App Intents to expose your app’s functionality to Siri. Understand which intents are already available for your use, and how to create custom intents to integrate actions from your app into the system. We’ll also cover what metadata to provide, making your entities searchable via Spotlight, annotating onscreen references, and much more.