com.tomtom.sdk.search:search-common

Overview

The Search Common module is a comprehensive collection of APIs that encapsulates functionality from various aspects of the Search SDK. This module integrates the following components:

  • General APIs: It includes frequently used APIs that facilitate error handling and provide shared classes applicable across multiple Search APIs.

  • Dynamic Data APIs: Real-time information is covered here, including:

    • Fuel Prices API

    • Parking Availability API

    • Parking Prices API

    • Electric Vehicle (EV) Charging Availability API

    These APIs provide essential data for drivers making informed decisions about parking and refueling or charging their vehicles.

  • Reverse Geocoding API: This aspect of the module offers the interface and data models necessary for transforming geographic coordinates (latitude and longitude) into human-readable addresses or location descriptions, enhancing user experience in location-based services.

  • Search API: The module encompasses the interface for the Search API, along with data models that encapsulate relevant information for implementing search functionality.

  • Structured Search API: This functionality acts as a hierarchical address selection tool, assisting users in navigating structured address data. It guides users through a hierarchy, from country-level selections down to individual house numbers, allowing them to explore options and refine their choices effectively. This feature is available only in offline mode.

Packages

Link copied to clipboard

Includes the interface for the Search API, alongside associated options, response data classes, and the callback interface.

Link copied to clipboard

Includes the interface for the Autocomplete API, alongside associated options, response data classes, and the callback interface.

Link copied to clipboard

Includes classes that represent any Search request failures that might occur during Search operations. These failures are encapsulated within the SearchFailure class.

Includes classes that represent common search result models shared across multiple search APIs.

Link copied to clipboard

Includes classes for integrating custom Point of Interest (POI) data sources into the Search engine, enhancing your application's search functionality with user-specific POIs.

Link copied to clipboard

Includes interfaces for information about EV charging availability, fuel prices, and parking details.

Link copied to clipboard

Includes interfaces for the Electric Vehicle (EV) Charging API implementation and all the associated options, response data classes, and the callback interface related to it.

Includes interfaces for the Fuel Price API implementation: the associated options, response data classes, and the callback interface related to it.

Includes the Electric Vehicle (EV) Charging Availability related models, applicable in the implementation of the EV charging availability provider.

Includes Fuel Prices related models, applicable in the implementation of the fuel price provider.

Includes Fuel Prices related models, applicable in the implementation of the fuel price provider.

Includes classes that are used in the implementation of the parking availability provider.

Includes classes that are used in the implementation of the parking price provider.

Includes the interfaces for the Parking Availability API implementation: the associated options, response data classes, and the callback interface related to it.

Includes the Parking Prices API related models, applicable in the implementation of the parking price provider.

Link copied to clipboard

Includes the interface for the EV Search (nearby and along the route) API, alongside associated options, response data classes and the callback interface.

Link copied to clipboard

Includes the callback interface for the Feedback API.

Link copied to clipboard

Includes the callback interface for the Geometry data API, alongside associated options and response data classes.

Link copied to clipboard

Includes the SearchResultType model.

Link copied to clipboard

Includes Search Feedback related models, which pertain to feedback events and their corresponding results.

Link copied to clipboard

Includes Geometry Search related models, which pertain to the different types of geometry and their corresponding data description.

Link copied to clipboard

Includes the Detour model, a class that describes the details about the detour from the route to the point of interest.

Link copied to clipboard

Includes classes which describe a certain Search, Autocomplete, EV Search or Point of Interest result.

Link copied to clipboard

Includes the SortOrder model, a class that describes the sorting way of results of a search along route.

Link copied to clipboard

Includes classes which summarize the parameters passed to a unique Search API call.

Link copied to clipboard

Includes the callback interface for the Point of interest categories API, alongside associated options and response data classes.

Link copied to clipboard

Provides the callback interface, options, and response data classes for the Point of Interest details API.

Link copied to clipboard

Includes the interfaces for the Reverse Geocoding API implementation: the associated options, response data classes, and the callback interface related to it.

Includes classes that set the parameters which define the geographical area and/or the type of address a Search is requested upon.

Includes the PlaceMatch class, which describes detailed information about a location obtained through reverse geocoding.

Link copied to clipboard

Includes the interfaces and models for the Structured Search implementation: the response/failure classes, and the callback interface related to it.

Includes the Structured Search related models, applicable in the implementation of the Structured Search provider.