NavManagerService

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
abstract suspend fun getNavigationState(): Result<NavigationState>

Retrieves the information about the navigation state.

Link copied to clipboard
abstract suspend fun navigateTo(destination: SearchResult, waypoints: List<SearchResult>): Result<Unit>

Sets the destination, optional waypoints and starts navigation.

Link copied to clipboard
abstract suspend fun recenterCamera(): Result<Unit>

Shows current user location.

Link copied to clipboard
abstract suspend fun search(query: String, options: SearchOptions): Result<List<SearchItem>>

Performs search, returning a list of places (SearchResult), Categories and Brands.

Link copied to clipboard
abstract suspend fun searchAlongRoute(query: String, options: SearchAlongTheRouteOptions): Result<List<SearchResult>>

Searches for places along the current route.

Link copied to clipboard
abstract suspend fun searchBrand(brand: Brand): Result<List<SearchResult>>

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

Link copied to clipboard
abstract suspend fun searchBrandAlongRoute(category: Brand, options: SearchAlongTheRouteOptions): Result<List<SearchResult>>

Same as searchAlongRoute, but searches within the given brand.

Link copied to clipboard
abstract suspend fun searchCategory(category: Category): Result<List<SearchResult>>

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
abstract suspend fun setDestination(destination: SearchResult, waypoints: List<SearchResult>): Result<Unit>

Shows preview of the route to the user. Does not start the navigation yet.

Link copied to clipboard
abstract suspend fun showOnMap(searchResults: List<SearchResult>): Result<Unit>

Opens the map and shows a list of places (SearchResult) on it. The app will be brought to the foreground.

Link copied to clipboard
abstract suspend fun showWaypoint(waypoint: SearchResult): Result<Unit>

Shows a waypoint acquired from getNavigationState. If the waypoint is not present in the NavigationState, undefined behaviour. Works only during NavigationState.ActiveGuidance.

Link copied to clipboard
abstract suspend fun startNavigation(): Result<Unit>

Start active guidance after a call to setDestination.

Link copied to clipboard
abstract suspend fun stopNavigation(): Result<Unit>

Stops navigation.