navigation-ux-search/com.mapbox.dash.sdk.search

Package-level declarations

Types

CurrentSearchScreen

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

enum CurrentSearchScreen : Enum<CurrentSearchScreen>

FavoriteAdditionResult

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

enum FavoriteAdditionResult : Enum<FavoriteAdditionResult>

ObserveSearchInteractionResultUseCase

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class ObserveSearchInteractionResultUseCase(searchStore: SearchStore)

OfflineSearchRegionsLoader

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class OfflineSearchRegionsLoader(locationRepository: LocationRepository, tileStore: TileStore, observerRoutes: ObserveRoutesUseCase) : DashStartupExecutor

This class is created as a workaround to the problem that search tiles downloaded by predictive cache aren't indexed until they are part of the region. This class adds to current-location and current-route region tiles which are already downloaded and are close to current position or current route See more details in https://mapbox.atlassian.net/browse/NAVAND-3404

ProcessSuggestionsQueryUseCase

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class ProcessSuggestionsQueryUseCase(getSearchAnchorPoint: GetSearchAnchorPointUseCase, searchStore: SearchStore, getConnectivityStatus: ObserveConnectivityStatusUseCase, search: SearchUseCase, informAboutSearchError: InformAboutSearchErrorUseCase, searchDelayMillis: Long = 300)

ResetSearchStateUseCase

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class ResetSearchStateUseCase(searchStore: SearchStore)

SearchAction

typealias SearchAction = SearchEvent.SearchAction

SearchAlongTheRouteOptions

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class SearchAlongTheRouteOptions(val routePoints: List<Point>, val deviationTimeMinutes: Long = 3)

Options to perform a SAR (search along the route) in the part of the route defined by the given points.

SearchEffect

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

sealed class SearchEffect

SearchEvent

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

sealed class SearchEvent

SearchFavoritesState

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

data class SearchFavoritesState(val homeSet: Boolean = false, val workSet: Boolean = false, val hasRegular: Boolean = false)

SearchInteractionResult

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

sealed class SearchInteractionResult

SearchResultFilterConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

interface SearchResultFilterConfig

SearchState

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

data class SearchState(val searchSuggestionState: SuggestionsResult = SuggestionsResult.Idle, val currentScreen: CurrentSearchScreen = CurrentSearchScreen.NONE, val favoriteSuggestionsState: SuggestionsResult = SuggestionsResult.Idle, val typeOfPlaceToAdd: FavoriteType? = null, val previousState: SearchState? = null, val searchQuery: String, val searchAnchor: Point?, val searchBoundingBox: BoundingBox?, val selectedFavorite: DestinationSearchResult? = null)

SearchStore

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class SearchStore

Functions

getRatingAndReviewCount

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

fun DestinationSearchResult.getRatingAndReviewCount(): Rating