Geocoder/com.benomad.msdk.geocoder/GeoCoder

GeoCoder

class GeoCoder : CPPAdapter

Remaps CBHLAddressLocator geocoding functions only

CPPAdapter is an instance of CBHLAddressLocator*

Since

v2.1.0 Creation

Constructors

constructor()

Types

object Companion

Properties

open var address: Long

var languageCode: Locale

Assigns a preferential language code for address lookup. Objects for which defined language code is not available, default language will be used.

val searchStatus: SearchStatus

Returns current search status.

var searchType: SearchType

Sets the type of search.

Functions

open override fun dispose()

Internal method

fun find(pattern: String, maxResult: Long, listener: GeoCoderSearchListener)

Calls find methods depending on current search status.

fun findCityPostal(pattern: String, maxResult: Long, listener: GeoCoderSearchListener)

Find a city or a postal code if current search status is SearchStatus.CITY or SearchStatus.POSTAL_CODE.

getSelectedAddress

fun getSelectedAddress(): Address?

Returns the current Address object. The address is filled after every call to GeoCoder.select.

fun getStreetRange(): Pair<Int, Int>?

Gets selected street's house number range if search status is SearchStatus.NUMBER.

fun moreItems(): Boolean

This method returns Boolean.true if after a call to one of Find methods there are more items that match than the parameter maxItems.

postalCodesAvailable

fun postalCodesAvailable(): Boolean

Check if postal codes are available for current selected country

fun reset(): Error?

Resets the Geocoder : clears current address and sets its search status to SearchStatus.COUNTRY

fun select(index: Int): Boolean

This method selects the ith item found in last call to one of #Find function. Call this method before calling #FindCity or #FinPostal to select a country, before #FindRoad or #FindPOI to select a city or postal district or before #FindNumberPos or #FindPOIPos to select a road or a POI.

selectHouseNumber

fun selectHouseNumber(houseNumber: String): Boolean

Sets a location at houseNumber street number (if search status is SearchStatus.NUMBER). Use empty string to set a location anywhere on selected street.

switchSearchStatus

fun switchSearchStatus(): Boolean

Switches search status. if search status is SearchStatus.CITY, search status becomes SearchStatus.POSTAL_CODE and vice versa. if search status is SearchStatus.ROAD, search status becomes SearchStatus.POI and vice versa. if search status is SearchStatus.NUMBER, search status becomes SearchStatus.CROSSROAD and vice versa.

upperSearchStatus

fun upperSearchStatus(): Boolean

Moves search status to upper level