VMEMapDescriptor

class VMEMapDescriptor

The map descriptor object contains information related to it's associated map bundle.

Since

v1.21

Constructors

Link copied to clipboard
fun VMEMapDescriptor(data: String, versionInfo: String)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Compare current VMEMapDescriptor with another.

Link copied to clipboard
open override fun hashCode(): Int

Properties

Link copied to clipboard
val data: String
Link copied to clipboard
lateinit var expiryDate: String

The expiry date of the map bundle. The format of the date is string YYYY/MM/DD, ISO short format, UTC. If the string is empty, then it indicates the map doesn't have an expiry date.

Link copied to clipboard
var id: String

Identifier of map (can be used within a filename).

Link copied to clipboard
val isValid: Boolean

True if this map descriptor represents a map bundle that can loaded by this SDK, otherwise false.

Link copied to clipboard
lateinit var layout: String

The layout name of the map bundle.

Link copied to clipboard
lateinit var mCustomDataHash: String

The custom data hash of the map bundle.

Link copied to clipboard
lateinit var name: String

The name of the map bundle, including it's domain.

Link copied to clipboard
lateinit var sdkMinVersion: String

The minimum version of SDK that can load the map which this map descriptor represents.

Link copied to clipboard
lateinit var sdkType: String

The SDK type that this map descriptor represents.

Link copied to clipboard
lateinit var sdkVersion: String

The SDK version that the map bundle was built for.

Link copied to clipboard
var secretCode: Int = 0

A secret code that is required in order to load the map.

Link copied to clipboard
lateinit var target: String

The target name of the map bundle.

Link copied to clipboard
var timestamp: Long

A timestamp indicating when the map was built (UTC + 0).

Link copied to clipboard
lateinit var zipFile: String

The filename of the map bundle as stored on the map server.