Maps SDK for Android/com.magiclane.sdk.places/SearchService

SearchService

class SearchService(var preferences: SearchPreferences = SearchPreferences(), var onStarted: OnStarted? = null, var onCompleted: OnSearchCompleted? = null, var locationHint: RectangleGeographicArea? = null) : GemNativeObj

Search service. It provides the support for map search, landmark search, search along route, and reverse geocode.

Constructors

Link copied to clipboard
constructor(preferences: SearchPreferences = SearchPreferences(), onStarted: OnStarted? = null, onCompleted: OnSearchCompleted? = null, locationHint: RectangleGeographicArea? = null)

Properties

Link copied to clipboard
val address: Long

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

Link copied to clipboard
var locationHint: RectangleGeographicArea?

The location hint. The search will be restricted to the provided geographic area.

Link copied to clipboard
var onCompleted: OnSearchCompleted?

On completed trigger

Link copied to clipboard
var onStarted: OnStarted?

On started trigger

Link copied to clipboard
var preferences: SearchPreferences

The service preferences.

Link copied to clipboard
val transferStatistics: TransferStatistics?

Gets data transfer statistics for this service.

Functions

Link copied to clipboard
fun cancelSearch()

Cancel specific request identified by the progress listener

Link copied to clipboard
fun finalize()

Overrides finalize that garbage collector will call when needed.

Link copied to clipboard
fun isReference(): Boolean

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

Link copied to clipboard
operator fun not(): Boolean

Checks if this object is valid.

Link copied to clipboard
fun release()

Releases the native referenced value of this object if:

Link copied to clipboard
fun search(addressInfo: AddressInfo, reference: Coordinates, onCompleted: OnSearchCompleted? = null, onStarted: OnStarted? = null): Int
fun search(mapView: MapView, addressInfo: AddressInfo, onCompleted: OnSearchCompleted? = null, onStarted: OnStarted? = null, allowUpdateLocationHint: Boolean = true): Int

Search using address and geographic @e area as discriminants.

Link copied to clipboard
fun searchAlongRoute(route: Route, categoryFilter: EGenericCategoriesIDs, textFilter: String = "", onCompleted: OnSearchCompleted? = null, onStarted: OnStarted? = null): Int
fun searchAlongRoute(route: Route, textFilter: String = "", categoryFilters: ArrayList<EGenericCategoriesIDs>? = null, onCompleted: OnSearchCompleted? = null, onStarted: OnStarted? = null): Int

Search for landmarks along the specified route.

Link copied to clipboard
fun searchAroundPosition(categoryFilter: EGenericCategoriesIDs, coords: Coordinates? = null, textFilter: String = "", onCompleted: OnSearchCompleted? = null, onStarted: OnStarted? = null): Int
fun searchAroundPosition(reference: Coordinates? = null, textFilter: String = "", categoryFilters: ArrayList<EGenericCategoriesIDs>? = null, onCompleted: OnSearchCompleted? = null, onStarted: OnStarted? = null): Int
fun searchAroundPosition(mapView: MapView, textFilter: String = "", categoryFilters: ArrayList<EGenericCategoriesIDs>? = null, onCompleted: OnSearchCompleted? = null, onStarted: OnStarted? = null, allowUpdateLocationHint: Boolean = true): Int

Get list of landmarks for specific coordinates.

Link copied to clipboard
fun searchByFilter(textFilter: String, categoryFilter: EGenericCategoriesIDs, reference: Coordinates? = null, onCompleted: OnSearchCompleted? = null, onStarted: OnStarted? = null): Int
fun searchByFilter(textFilter: String, reference: Coordinates? = null, categoryFilters: ArrayList<EGenericCategoriesIDs>? = null, onCompleted: OnSearchCompleted? = null, onStarted: OnStarted? = null): Int
fun searchByFilter(mapView: MapView, textFilter: String, categoryFilters: ArrayList<EGenericCategoriesIDs>? = null, onCompleted: OnSearchCompleted? = null, onStarted: OnStarted? = null, allowUpdateLocationHint: Boolean = true): Int

Search using textual, address and geographic area as discriminants.