Package-level declarations

Functions

Link copied to clipboard
suspend fun NavManagerService.calculateSearchResultRouteInfo(searchResult: SearchResult, withChargingStations: Boolean = false): Result<SearchResultRouteInfo>

Calculates route information (distance and ETA) from the user's current location to a search result. Performance Note: Due to computational complexity, it's expensive to calculate accurate ETA and precise route distance. These calculations involve routing algorithms and real-time traffic data processing, which can significantly impact performance when processing multiple search results simultaneously.

Link copied to clipboard

Performs one-off search request to get a list of search results.

Link copied to clipboard
suspend fun NavManagerService.getDestinationHistory(pageNumber: Int, pageSize: Int = 10): Result<List<SearchItem>>

Retrieves the user's destination search history with pagination support. When empty list is returned, the previous page was the last one

Link copied to clipboard

Retrieves the list of favorite places.

Link copied to clipboard

Returns points of the active route. If there are more points than a hardcoded limit, intermediate points will be thrown away to return no more points than the limit. If there's a route progress, only the points ahead of user will be returned.

Link copied to clipboard

Retrieves the current route options configuration.

Link copied to clipboard

Emits updates to the favorites list whenever favorites are added, removed, or modified.

Link copied to clipboard

Emits new objects when detailed information about the SearchResult is shown or hidden. For example, when the user has performed search and then clicked one of the found results, and then clicked "Back".

Link copied to clipboard

Emits new route options whenever the route configuration changes.

Link copied to clipboard

Emits search UI updates: when it's shown, scrolled, closed.

Link copied to clipboard

Removes a place from the favorites list.

Link copied to clipboard

Performs revers geocoding to get a list of places (SearchResult) by given coordinate.

Link copied to clipboard

Saves a place to the favorites list.

Link copied to clipboard

Scrolls the search results UI to a certain SearchResult. The list of SearchResult os available by observing observeSearchUIUpdated, more precisely by accessing the SearchUIState.items property.

Link copied to clipboard

Performs suggestions search, returning a list of places (SearchResult), Categories and Brands. Will be slower than forward, because each found suggestion will be resolved under the hood.

Link copied to clipboard

Searches for places along the current route.

Link copied to clipboard

Perform search within the given category (returned by search).

Link copied to clipboard

Same as searchAlongRoute, but searches within the given category.

Link copied to clipboard

Updates the route options configuration.

Link copied to clipboard

Shows UI with detailed information about a SearchResult. Note: if the SearchResult is part of the route, you should rather call showWaypoint.