TomTom SDK for iOS HybridReverseGeocoder

HybridReverseGeocoder

public final class HybridReverseGeocoder : ReverseGeocoder

Implementation of Reverse Geocoding API that wraps online and offline reverse geocoders. When online service is unavailable offline service is automatically used to improve availability.

Important

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

  • Creates a new HybridReverseGeocoder instance.

    Throws

    An error if NDSStore is invalid.

    Important

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

    Declaration

    Swift

    public convenience init(
    apiKey: String,
    store: NDSStore,
    timeout: Measurement<UnitDuration> = .tt.seconds(5),
    customAPIURL: URL? = nil
) throws

    Parameters

    apiKey

    A valid TomTom API Key.
    store

    NDSStore offline map handle. Additionally, NDSStore defines the overall geopolitical view for both online and offline in HybridSearch. Configure the corresponding geopolitical view in NDSStoreConfiguration and initialize NDSStore with it.
    timeout

    The duration after which primary geocoder results are ignored and the fallback geocoder starts handling the query.
    customAPIURL

    Custom base URL for online APIs. Defaults to nil and “https://api.tomtom.com/search/2” will be the base URL. Can be used to change to another service that implements the same API.

  • Reverse Geocoding API gives users a tool to translate a coordinate (for example: 37.786505, -122.3862) into a human-understandable street address, street element, or geography.

    Important

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

    Declaration

    Swift

    public func reverseGeocode(
    options: ReverseGeocoderOptions,
    completion: @escaping (Result<ReverseGeocoderResponse, Error>) -> ()
)

    Parameters

    options
    completion

    Parameter completion: The completion closure is called after the response to the request has been processed. If no errors occurred, ReverseGeocoderResponse contains an array of categories and subcategories together with their translations and synonyms.