OnlineSearch

final public class OnlineSearch : Search

The Online Search API is a REST wrapper for a suite of web services that allow developers to use our scalable search engine.

Lifecycle

  • OnlineSearch init method.

    Important

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

    Declaration

    Swift

    public convenience init(apiKey: String, customAPIURL: URL? = nil, geopoliticalView: String? = nil)

    Parameters

    apiKey

    a valid Search API key.
    customAPIURL

    custom base URL for online APIs.
    geopoliticalView

    the country code in the ISO 3166-1 alpha-2 format whose view on disputed areas should be used. If not provided, or not supported, the international geopolitical view will be used.

Public

  • This API allows to search places and POIs meeting various criteria.

    Declaration

    Swift

    public func search(options: SearchOptions, completion: @escaping (Result<SearchResponse, Error>) -> ())

    Parameters

    options

    The SearchOptions structure to tune the results.
    completion

    The completion closure is called after the response to the request has been processed. If no errors occurred, SearchResponse contains an array of search results and summary information.

  • This API provides a list of POI categories.

    Declaration

    Swift

    public func requestPOICategories(
    options: POICategoryOptions,
    completion: @escaping (Result<POICategoryResponse, Error>) -> ()
)

    Parameters

    options

    The POICategoryOptions structure to tune the results.
    completion

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

  • The Autocomplete API enables you to make a more meaningful Search API call by recognizing entities inside an input query and offering them as query terms.

    Declaration

    Swift

    public func autocomplete(
    options: AutocompleteOptions,
    completion: @escaping (Result<AutocompleteResponse, Error>) -> ()
)

    Parameters

    options

    The AutocompleteOptions structure to filter the results.
    completion

    The completion closure is called after the response to the request has been processed. If no errors occurred, AutocompleteResponse contains proposed autocomplete elements, that can be used to implement an input field with the autocomplete feature.

  • This API provides detailed information about a place based on its identifier (entityId).

    Declaration

    Swift

    public func requestPOIDetails(
    options: POIDetailsOptions,
    completion: @escaping (Result<TomTomSDKSearch.POIDetailsResponse, Error>) -> ()
)

    Parameters

    options

    Describes what POI Details data to request.
    completion

    The completion closure is called after the response to the request has been processed. If no errors occurred, POIDetailsResponse contains a search result associated with the requested POI.

  • The Geometries Data API returns sets of coordinates that represent the outline of a city, country, or land area. The API supports batch requests of up to 20 identifiers.

    • options: Defines geometries to request.
    • completion: Parameter completion: The completion closure is called after the response to the request has been processed. If no errors occurred, GeometryDataResponse contains an array of geometries data structures

    Declaration

    Swift

    public func requestGeometryData(
    options: GeometryDataOptions,
    completion: @escaping (Result<GeometryDataResponse, Error>) -> ()
)

  • Asynchronously sends a feedback event for the search.

    Important

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

    Declaration

    Swift

    public func sendFeedback(feedbackEvent: TomTomSDKSearch.FeedbackEvent, completion: ((Error?) -> ())? = nil)

    Parameters

    feedbackEvent

    The feedback event.
    completion

    If an error occurred, completion is called with error.