OfflineStructuredSearch

public final class OfflineStructuredSearch : StructuredSearch

Structured Search implementation that uses offline map data. For more information, see StructuredSearch.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle


                    
                    
                    init(store:)

Creates an OfflineStructuredSearch instance with given parameters.

Throws

An error if NDSStore is invalid.

Declaration

Swift

public convenience init(store: NDSStore) throws

Parameters


                                store

The NDSStore object that contains the map data.

Public


                    
                    
                    createSearchSession(locale:)

Start a new search session to find the full address hierarchically with preferred locale. The locale is used to find the best representation of strings in StructuredSearchCandidate, and can be changed later when operating with StructuredSearchSession.

Throws

An error if NDSStore is invalid.

Declaration

Swift

public func createSearchSession(locale: Locale) throws -> StructuredSearchSession

Parameters


                                locale

The preferred Locale.

Return Value

A StructuredSearchSession object that could be used to perform structured search.