Upgrading InstantSearch iOS

As of May 1st, 2024, Apple requires all iOS apps to include a privacy manifest. Ensure you incorporate our provided privacy manifest files into your documentation. For more details, see Privacy Manifest.

Update event tracking

Starting from v7.26.2, InstantSearch makes it easier to send view events using the isAutoSendingHitsViewEvents option on HitsSearcher:

1
2
3
4
let searcher = HitsSearcher(appId: "YourApplicationID",
                            apiKey: "YourSearchOnlyAPIKey",
                            index: "indexName",
                            isAutoSendingHitsViewEvents: true)

From v7.24.0 to v7.26.1, view events were sent automatically. Ensure you’re using the latest version of InstantSearch to send the required events.

Upgrade to InstantSearch iOS v5

InstantSearch v5 introduces a new architecture and new widgets, which brings several breaking changes from the previous versions:

• No longer an InstantSearch component automatically connecting widgets. You are now in control of the Searcher and responsible for connecting and disconnecting it from widgets and other components.
• The widgets are now built around Interactors, holding their data and business logic.
  Compared to the previous versions, where widgets were iOS UIViews, now the core of the widget is its interactor, and the UI is behind an interface to ensure minimal coupling.

You can learn more about the philosophy of InstantSearch iOS v5 in What’s InstantSearch. Once ready to start migrating, learn the steps to building an app with InstantSearch in the getting started guide.

The InstantSearch iOS v3 documentation is available on the legacy docs page.