Instance Method


Tells the delegate to reindex all searchable data and clear all local state information.



func searchableIndex(_ searchableIndex: CSSearchableIndex, reindexAllSearchableItemsWithAcknowledgementHandler acknowledgementHandler: @escaping () -> Void)



The index in which to reindex the searchable data. The delegate or app extension should pass searchableIndex to indexSearchableItems(_:completionHandler:).


The handler to call after all client state has been saved. Note that if the app passes client state information in a batch (for example, by calling endBatch(withClientState:completionHandler:)), the acknowledgement handler can be called immediately.

The delegate or app extension must call the acknowledgement handler after all client state information has been saved, so that the indexer can call this method again in case of a crash.


Typically, the index tells the delegate to reindex its searchable data and clear local state when the index has been lost. An app extension should not use the index passed in searchableIndex when a custom data protection class is needed.

See Also

Updating the Index

func searchableIndex(CSSearchableIndex, reindexSearchableItemsWithIdentifiers: [String], acknowledgementHandler: () -> Void)

Tells the delegate to reindex the searchable items associated with the specified identifiers.


Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software