Documentation for maplib/Json.kt
- class JsonDocument
Json document class.
- fun constructor(handle: Long = API.jsonDocumentCreateInt())
Main constructor
- Parameters
handle – e C API handle.
- fun load(url: String, options: Map<String, String> = mapOf(), callback: ((status: StatusCode, complete: Double, message: String) -> Boolean)? = null) : Boolean
Load document from url.
- Parameters
url – Url to fetch Json document.
options – Options passed to the http request function. See Request.get for details.
callback – Callback function to show progress or cancel operation.
- Returns
True on success.
- fun getRoot() : JsonObject
Get json document root object.
- Returns
JsonObject class instance.
- class JsonObject
JsonObject class.
- fun constructor(handle: Long = 0)
Main constructor
- Parameters
handle – e C API handle. For new objects is 0.
- val handle : Long = 0
e C API handle. For new objects is 0.
- val type : JsonObjectType
Json object type.
- fun getString(defaultValue: String) : String
Get string from json object.
- Parameters
defaultValue – Default string value.
- Returns
string
- fun getDouble(defaultValue: Double) : Double
Get double from json object.
- Parameters
defaultValue – Default double value.
- Returns
double
- fun getInteger(defaultValue: Int) : Int
Get int from json object.
- Parameters
defaultValue – Default int value.
- Returns
integer
- fun getLong(defaultValue: Long) : Long
Get long from json object.
- Parameters
defaultValue – Default long value.
- Returns
long
- fun getBool(defaultValue: Boolean) : Boolean
Get bool from json object.
- Parameters
defaultValue – Default bool value.
- Returns
boolean
- fun getObject(name: String) : JsonObject
Get json object from json object.
- Parameters
name – Key name.
- Returns
json object.
- fun getString(key: String, defaultValue: String) : String
Get string from json object.
- Parameters
key – Key value.
defaultValue – Default value.
- Returns
String value.
- fun getDouble(key: String, defaultValue: Double) : Double
Get double from json object.
- Parameters
key – Key value.
defaultValue – Default value.
- Returns
Double value.
- fun getInteger(key: String, defaultValue: Int) : Int
Get integer from json object.
- Parameters
key – Key value.
defaultValue – Default value.
- Returns
Integer value.
- fun getLong(key: String, defaultValue: Long) : Long
Get long from json object.
- Parameters
key – Key value.
defaultValue – Default value.
- Returns
Long value.
- fun getBool(key: String, defaultValue: Boolean) : Boolean
Get bool from json object.
- Parameters
key – Key value.
defaultValue – Default value.
- Returns
Boolean value.
- fun setString(key: String, value: String) : Boolean
Set string value.
- Parameters
value – Value to set.
key – Key value.
- Returns
True on success.
- fun setDouble(key: String, value: Double) : Boolean
Set double value.
- Parameters
value – Value to set.
key – Key value.
- Returns
True on success.
- fun setInteger(key: String, value: Int) : Boolean
Set integer value.
- Parameters
value – Value to set.
key – Key value.
- Returns
True on success.
- fun setLong(key: String, value: Long) : Boolean
Set long value.
- Parameters
value – Value to set.
key – Key value.
- Returns
True on success.
- fun setBoolean(key: String, value: Boolean) : Boolean
Set boolean value.
- Parameters
value – Value to set.
key – Key value.
- Returns
True on success.
- fun children() : Array<JsonObject>
Get json object children.
- Returns
Array of children.
- fun getArray(name: String) : JsonArray
Get array by name.
- Parameters
name – Array object name.
- Returns
Json array object.
- enum class JsonObjectType
Json object type.
NULL = 1 : Null object.
OBJECT = 2 : Another object.
ARRAY = 3 : Array of json objects.
BOOLEAN = 4 : Boolean object.
STRING = 5 : String object.
INTEGER = 6 : Integer object.
LONG = 7 : Long object.
DOUBLE = 8 : Double object.
- class JsonArray
Json array class.
- constructor(handle Long )
Main constructor
- fun getItem(index: Int) : JsonObject
Get item by index. Index mast be between 0 and size.
- Parameters
index – Item index.
- Returns
Json object.