Documentation for MapLib/Json.swift

class JsonDocument

Json document class.

init()

Init empty document.

func load()

Load document from url.

Parameters
  • url – Url to fetch Json document.

  • options – Options passed to the http request function. See Request.get for detailes.

  • callback – Callback function to show progress or cancel operation.

Returns

True on success.

func getRoot() JsonObject

Get json document root object.

Returns

JsonObject class instance.

class JsonObject

JsonObject class

var valid : Bool

If json object valid the property will be tru. The property is redonly.

var name : String

Json object name.

var type : jsonObjectType

Json object type.

func getString(with defaultValue:String) String

Get string from json object.

Parameters
  • defaultValue – Default string value.

Returns

string.

func getDouble(with defaultValue:Double) Double

Get double from json object.

Parameters
  • defaultValue – Default double value.

Returns

double.

func getInteger(with defaultValue:Int32) Int32

Get int from json object.

Parameters
  • defaultValue – Default int value.

Returns

int.

func getLong(with defaultValue:Int) Int

Get long from json object.

Parameters
  • defaultValue – Default long value.

Returns

long.

func getBool(with defaultValue:Bool) Bool

Get bool from json object.

Parameters
  • defaultValue – Default bool value.

Returns

bool.

func getObject(name: String) JsonObject

Get json object from json object.

Parameters
  • defaultValue – Default json object value.

Returns

json object.

func getString(for key:String, with defaultValue:String) String

Get string from json object.

Parameters
  • key – Key value.

  • defaultValue – Default value.

Returns

String value.

func getDouble(for key:String, with defaultValue:Double) Double

Get double from json object.

Parameters
  • key – Key value.

  • defaultValue – Default value.

Returns

Double value.

func getInteger(for key:String, with defaultValue:Int32) Int32

Get integer from json object.

Parameters
  • key – Key value.

  • defaultValue – Default value.

Returns

Integer value.

func getLong(for key:String, with defaultValue:Int) Int

Get long from json object.

Parameters
  • key – Key value.

  • defaultValue – Default value.

Returns

Long value.

func getBool(for key:String, with defaultValue:Bool) Bool

Get bool from json object.

Parameters
  • key – Key value.

  • defaultValue – Default value.

Returns

Boolean value.

func set(string value:String, for key:String) Bool

Set string value.

Parameters
  • value – Value to set.

  • key – Key value.

Returns

True on success.

func set(double value:Double, for key:String) Bool

Set double value.

Parameters
  • value – Value to set.

  • key – Key value.

Returns

True on success.

func set(int value:Int32, for key:String) Bool

Set integer value.

Parameters
  • value – Value to set.

  • key – Key value.

Returns

True on success.

func set(long value:Int, for key:String) Bool

Set long value.

Parameters
  • value – Value to set.

  • key – Key value.

Returns

True on success.

func set(bool value:Bool, for key:String) Bool

Set boolean value.

Parameters
  • value – Value to set.

  • key – Key value.

Returns

True on success.

func children() [JsonObject]

Get json object children.

Returns

Array of children.

func getArray(name: String) JsonArray

Get array by name.

Parameters
  • name – Array object name.

Returns

Json array object.

enum jsonObjectType : Int32

Json object type.

  • NULL: Null object.

  • OBJECT: Another object.

  • ARRAY: Array of json objects.

  • BOOLEAN: Boolean object.

  • STRING: String object.

  • INTEGER: Integer object.

  • LONG: Long object.

  • DOUBLE: Double object.

class JsonArray : JsonObject

Json array class.

var size : Int32

Item count.

func getItem(with index:Int32) JsonObject

Get item by index. Index mas be between 0 and size.

Parameters
  • index – Item index.

Returns

Json object.