TomTom SDK for iOS OfflineStructuredSearchSession

OfflineStructuredSearchSession

@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
public final class OfflineStructuredSearchSession : StructuredSearchSession

StructuredSearchSession implementation that uses offline map data. For more information, see StructuredSearchSession.


                    
                    
                    fetchStructuredSearchState(completion:)

Fetch the current structured search state. This can be used to retrieve the initial state with candidates representing the top level of address, such as country.

Declaration

Swift

public func fetchStructuredSearchState(completion: @escaping (Result<StructuredSearchResponse, Error>) -> ())

Parameters


                                completion

The completion closure is called after the response to the request has been processed. If no errors occurred, StructuredSearchResponse contains the latest structured search state.


                    
                    
                    goBack(step:completion:)

Go back to previous selection from current step. step must be a positive value. If step is larger than the number of steps that have been taken, e.g. goBack is called with step set to 9 at the third step, it goes back to the first step.

Declaration

Swift

public func goBack(step: Int, completion: @escaping (Result<StructuredSearchResponse, Error>) -> ())

Parameters

`step`	The number of step to go back.
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `StructuredSearchResponse` contains the latest structured search state.


                    
                    
                    selectCandidate(candidate:completion:)

Select a specific candidate in the current step. This will advance to the next step of the search path.

Declaration

Swift

public func selectCandidate(
    candidate: StructuredSearchCandidate,
    completion: @escaping (Result<StructuredSearchResponse, Error>) -> ()
)

Parameters

`candidate`	The candidate to select in the current step.
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `StructuredSearchResponse` contains the latest structured search state.


                    
                    
                    setLocale(locale:completion:)

Set locale for the search session. The locale is used to find the best representation of strings in StructuredSearchCandidate.

Declaration

Swift

public func setLocale(locale: Locale, completion: @escaping (Result<StructuredSearchResponse, Error>) -> ())

Parameters

`locale`	The preferred `Locale`.
`completion`	The completion closure is called after changing locale has been finished. If no errors occurred, `StructuredSearchResponse` contains the latest structured search state.