indexSearchableItems(_:completionHandler:)

Adds or updates items in the index.

Declaration

func indexSearchableItems(_ items: [CSSearchableItem], completionHandler: (@Sendable ((any Error)?) -> Void)? = nil)

func indexSearchableItems(_ items: [CSSearchableItem]) async throws

Parameters

items:
An array of searchable items to add or update.
completionHandler:
The block that’s called when the data has been journaled by the index, which means that the index makes a note that it has to perform this operation. If the completion handler returns an error, it means that the data wasn’t journaled correctly and the client should retry the request.
The block receives the following parameter:
error
If an error occurred, this parameter holds an error object that explains the error. Otherwise, the value of this parameter is nil.

Mentioned in

Adding your app’s content to Spotlight indexes

Discussion

important:

You can call this method from synchronous code using a completion handler, as shown on this page, or you can call it as an asynchronous method that has the following declaration:

func indexSearchableItems(_ items: [CSSearchableItem]) async throws

For information about concurrency and asynchronous code in Swift, see Calling Objective-C APIs Asynchronously.

The searchableIndex(_:reindexSearchableItemsWithIdentifiers:acknowledgementHandler:) protocol method is called in the case that the journaling completed successfully but the data was not able to be indexed for some reason.