Maps SDK for Android/com.magiclane.sdk.core/MapDetails

MapDetails

class MapDetails : GemNativeObj

MapDetails object. It provides the attributes of a map at the specified coordinates.

Constructors

constructor()

constructor(address: Long)

Properties

val address: Long

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

countryDataCount

val countryDataCount: Int

Country data count

isoCodeForCurrentPosition

val isoCodeForCurrentPosition: String?

Returns ISOCode for current PositionService.position. If no position null will be returned else will return result of getCountryCode.

mapExtendedCapabilities

val mapExtendedCapabilities: Int

Get map extended capabilities as int. Check EMapExtendedCapability for possible return values.

val mapProviderIds: ArrayList<Int>?

Map provider IDs list. The function returns the list of map provider IDs. It may be empty if no map data is available on the device.

Functions

Overrides finalize that garbage collector will call when needed.

getCountryBoundingRectangle

external fun getCountryBoundingRectangle(isoCode: String): RectangleGeographicArea?

Get the country bounding rectangle for the isoCode.

external fun getCountryCode(coords: Coordinates): String?

Get the ISO 3166-1 alpha-3 country code for the specified WGS. Empty string means no country. See: http://en.wikipedia.org/wiki/ISO_3166-1 for the list of codes.

getCountryCodeByIndex

external fun getCountryCodeByIndex(index: Int): String?

Get country iso code

external fun getCountryFlag(isoCode: String): Image?

Get the country flag for the isoCode.

getCountryImageByIndex

external fun getCountryImageByIndex(index: Int): Image?

Get country image

getCountryMapCapabilities

external fun getCountryMapCapabilities(code: String): Int

Get the capabilities for a country map. This method checks the data available on the device. Check ECountryCapability for possible return values.

getCountryMapCoverage

fun getCountryMapCoverage(code: String): EMapCoverage

Get the map coverage for the country specified by ISO 3166-1 alpha-3 country code. This function checks the map coverage status using only the information available on the device. No server connection is performed. This check is performed fast.

external fun getCountryName(coords: Coordinates): String?

Get the country name for the specified WGS.

external fun getCountryName(isoCode: String): String?

Get the country name for the isoCode.

getCountryNameByIndex

external fun getCountryNameByIndex(index: Int): String?

Get country name

fun getMapCoverage(coords: Coordinates): EMapCoverage

Get the map coverage for the region specified by WGS84 coordinates. This function checks only using the information available on device the status about map the coverage at the specified coordinates. No server connection is performed. This check is performed fast.

getProviderLogo

fun getProviderLogo(id: EMapProviderId): Image?

Get the logo of the specified provider.

getProviderName

fun getProviderName(id: EMapProviderId): String?

Get the name of the specified provider.

getProviderSentence

fun getProviderSentence(id: EMapProviderId): String?

Get the copyright sentence for the specified provider.

getSunriseAndSunset

external fun getSunriseAndSunset(coords: Coordinates, refTime: Time? = null): Pair<Time, Time>?

Get the sunrise & sunset for the specified reference date and WGS position. If no time is provided then the device time is used.

external fun isNight(coords: Coordinates, refTime: Time? = null): Boolean

Check if it is night at the specified coordinated and time. If no time is provided then the device time is used.

fun isReference(): Boolean

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

operator fun not(): Boolean

Checks if this object is valid.

Releases the native referenced value of this object if: