sdk-common/com.mapbox.search.common

Package-level declarations

Types

Represents the result (task handle) of an asynchronous operation.

@MapboxExperimental

class BusinessDetails @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) constructor(val name: String, val website: String? = null, val logo: ImageInfo? = null) : Parcelable

This class contains information about a business, for example, EV Charging Station operator OCPI BusinessDetail.

CompletionCallback

interface CompletionCallback<T>

Interface definition for a commonly used in the Search SDK callback to be invoked when asynchronous operation completes.

DistanceCalculator

interface DistanceCalculator

Distance calculator for WGS84 (Earth as spheroid). Should be initialized by latitude and used in some not far around area.

Facility

@MapboxExperimental

object Facility

Facility type. One of the examples is OCPI Facility.

HighlightsCalculator

interface HighlightsCalculator

Used to calculate which parts of exact search result name will be highlighted.

IsoCountryCode

class IsoCountryCode(val code: String) : Parcelable

Iso Country Code.

IsoLanguageCode

class IsoLanguageCode(val code: String) : Parcelable

Iso Language Code.

LocalizedText

@MapboxExperimental

class LocalizedText @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) constructor(val language: String, val text: String) : Parcelable

Represents a piece of text associated with a specific language. One of examples is OCPI DisplayText.

NavigationProfile

class NavigationProfile(val rawName: String) : Parcelable

Type of movement. Used to calculate distance and time of arrival (ETA) from origin point to a search suggestion and search result.

OsmIdUtils

object OsmIdUtils

Utility class.

RestrictedMapboxSearchAPI

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class RestrictedMapboxSearchAPI

This annotation marks the Search SDK API that is available for selected customers only. By default, API annotated with @RestrictedMapboxSearchAPI returns null or empty/stub data. Contact our team, if you're interested in restricted API usage.

RoutablePoint

class RoutablePoint(val point: Point, val name: String) : Parcelable

Represents entry to the building, associated with original search result.

SearchCancellationException

class SearchCancellationException(val message: String) : RuntimeException

Exception thrown when a search request was automatically cancelled by the Search SDK.

SearchRequestException

class SearchRequestException(val message: String, val code: Int, val cause: Exception? = null) : RuntimeException

Exception thrown when an HTTP response was not successful, i.e. if the code is not in [200..300).