JSON

length: Number

read-only

Property that retrieves the number of items in a JSON Array, wraps getArrayCount()

See also:
#getArrayCount()

applyField ( o: Object , field: String ): Void

Convenience method that sets the field on the provided object using the JSON value of the same name.

fromDictionary ( d: Dictionary.<String, Object> ): JSON

static

Creates a JSON object from the given Dictionary mapping keys to values. The setValue function is the primary force behind the conversion, see setValue for limitations and additional information.

See also:
#setValue()

fromVector ( v: Vector.<Object> ): JSON

static

Creates a JSON array from the given Vector of objects. The setArrayValue function is the primary force behind the conversion, see setArrayValue for limitations and additional information.

See also:
#setArrayValue()

getArray ( key: String ): JSON

native

For a JSON Object, retrieves the JSON Array value associated with the provided key.

The object returned is a JSON array (ordered set of values).

See also:
#getArrayJSONType()
#getArrayCount()
#getArrayBoolean()
#getArrayInteger()
#getArrayString()
#getArrayArray()
#getArrayObject()

getArrayArray ( index: Number ): JSON

native

For a JSON Array, retrieves a JSON Array value at the provided index.

getArrayBoolean ( index: Number ): Boolean

native

For a JSON Array, retrieves a Boolean value at the provided index.

getArrayCount (): Number

native

For a JSON Array, retrieves the number of items.

getArrayFloat ( index: Number ): Number

native

For a JSON Array, retrieves a Number value at the provided index. Alias of getNumber so it converts integers to floats instead of returning 0.

getArrayInteger ( index: Number ): Number

native

For a JSON Array, retrieves a 32-bit Integer value at the provided index.

getArrayJSONType ( index: Number ): JSONType

native

For a JSON Array, retrieves the type of the value at the provided index.

getArrayNumber ( index: Number ): Number

native

For a JSON Array, retrieves a Number (64-bit Float or 32-bit Integer) value at the provided index.

getArrayObject ( index: Number ): JSON

native

For a JSON Array, retrieves a JSON Object value at the provided index.

getArrayString ( index: Number ): String

native

For a JSON Array, retrieves a String value at the provided index.

getArrayValue ( index: Number ): Object

General function that gets the value of the index provided in Json Arrays

getBoolean ( key: String ): Boolean

native

For a JSON Object, retrieves the Boolean value associated with the provided key.

See also:
#setBoolean()

getDictionary (): Dictionary

Create a Loom friendly dictionary from this JSON object. Note that if there are any JSON Objects or JSON Arrays nested within this object then thay will not be recursively converted.

can contain Numbers, Strings, Booleans, JSON Arrays, and JSON Objects. Will return NULL if this JSON object is empty or is a JSON Array.

getError (): String

native

Retrieves a string representation of the last error thrown.

getFloat ( key: String ): Number

native

For a JSON Object, retrieves the Number associated with the provided key. Alias of getNumber so it converts integers to floats instead of returning 0.

See also:
#setFloat()

getFullTypeName (): String
Inherited from Object

native

Gets the fully qualified type name of the Object. The fully qualified type name includes the package of the type.

getInteger ( key: String ): Number

native

For a JSON Object, retrieves the 32-bit Integer value associated with the provided key.

Note: LoomScript does not support 64-bit integers natively, but longer integers can be retrieved as Strings via getLongLongAsString().

See also:
#getLongLongAsString()

getJSONType (): JSONType

native

Retrieves the type of the current JSON Object.

See also:
system.JSONType

getLongLongAsString ( key: String ): String

native

For a JSON Object, retrieves a String representation of the 64-bit Integer value associated with the provided key.

LoomScript does not support 64-bit integers natively.

getNumber ( key: String ): Number

native

For a JSON Object, retrieves the number value (64-bit Float or 32-bit Integer) associated with the provided key.

See also:
#setFloat()

getObject ( key: String ): JSON

native

For a JSON Object, retrieves the JSON Object value associated with the provided key.

The object returned is a JSON Object (map of key-value pairs).

See also:
#getObjectJSONType()
#getObjectFirstKey()
#getObjectNextKey()
#getBoolean()
#getInteger()
#getLongLongAsString()
#getFloat()
#getString()
#getArray()
#getObject()

getObjectFirstKey (): String

native

For a JSON Object, retrieves the name of the first key in the property list.

getObjectJSONType ( key: String ): JSONType

native

For a JSON Object, retrieves the type of the value associated with the provided key.

getObjectNextKey ( key: String ): String

native

For a JSON Object, retrieves the name of the key immediately following the provided key in the property list.

getString ( key: String ): String

native

For a JSON Object, retrieves the String value associated with the provided key.

See also:
#setString()

getType (): Type
Inherited from Object

native

Gets the Type that describes the Object.

getTypeName (): String
Inherited from Object

native

Gets the type name of the Object.

getValue ( key: String ): Object

General function that gets the value of the Key provided

getVector (): Vector

Create a Loom friendly vector from this JSON array. Note that if there are any JSON Objects or JSON Arrays nested within this array then thay will not be recursively converted.

can contain Numbers, Strings, Booleans, JSON Arrays, and JSON Objects. Will return NULL if this JSON arrat is empty or is a JSON object.

initArray (): Boolean

native

Initialize the JSON instance as an empty JSON array, clearing all the previously held values.

initObject (): Boolean

native

Initialize the JSON instance as an empty JSON object, clearing all the previously held values.

isArray (): Boolean

native

Indicates whether the JSON Object is considered an Array.

isObject (): Boolean

native

Indicates whether the JSON Object is considered an Object.

loadString ( json: String ): Boolean

native

Loads a JSON-formatted string into memory. Required before getters can be called.

If parsing fails, the getError() method will return the error message.

The serialize() method will convert the in-memory data back to a JSON string.

See also:
#getError()
#serialize()

parse ( json: String ): JSON

static

Convenience function will parse a JSON string and return a JSON object. This is functionally the same as creating initializing a new JSON Loom object and loading a string into it, but this function will assert "JSON failed to load" if the call to loadString fails.

serialize (): String

native

Serializes the in-memory data structure to a JSON formatted String.

See also:
#loadString()

setArray ( key: String , value: JSON ): Void

native

For a JSON Object, associates a JSON Array value with the provided key.

This value can be later retrieved with getArray(key).

See also:
#getArray()

setArrayArray ( index: Number , value: JSON ): Void

native

For a JSON Array, associates a JSON Array value with the provided index.

This value can be later retrieved with getArrayArray(index).

See also:
#getArrayArray()

setArrayBoolean ( index: Number , value: Boolean ): Void

native

For a JSON Array, associates a Boolean value with the provided index.

This value can be later retrieved with getArrayBoolean(index).

See also:
#getArrayBoolean()

setArrayDictionary ( index: Number , d: Dictionary.<String, Object> ): Void

Sets the value of the array index to the JSON object created from the provided Dictionary using fromDictionary.

setArrayFloat ( index: Number , value: Number ): Void

native

For a JSON Array, associates a 64-bit Float value with the provided index.

This value can be later retrieved with getArrayFloat(index).

See also:
#getArrayFloat()

setArrayInteger ( index: Number , value: Number ): Void

native

For a JSON Array, associates a 32-bit Integer value with the provided index.

This value can be later retrieved with getArrayInteger(index).

See also:
#getArrayInteger()

setArrayNumber ( index: Number , value: Number ): Void

native

For a JSON Array, associates a Number (64-bit Float) value with the provided index.

This value can be later retrieved with getArrayNumber(index).

See also:
#getArrayNumber()

setArrayObject ( index: Number , value: JSON ): Void

native

For a JSON Array, associates a JSON Object value with the provided index.

This value can be later retrieved with getArrayObject(index).

See also:
#getArrayObject()

setArrayString ( index: Number , value: String ): Void

native

For a JSON Array, associates a String value with the provided index.

This value can be later retrieved with getArrayString(index).

See also:
#getArrayString()

setArrayValue ( index: Number , o: Object ): Void

General function that sets the value of the array index based on the type of object. Allowed datatypes are system.Boolean, system.Number, system.String, system.Vector, and system.Dictionary.

setArrayVector ( index: Number , v: Vector.<Object> ): Void

Sets the value of the array index to the JSON array created from the provided Vector using fromVector.

setBoolean ( key: String , value: Boolean ): Void

native

For a JSON Object, associates a Boolean value with the provided key.

This value can be later retrieved with getBoolean(key).

See also:
#getBoolean()

setDictionary ( key: String , d: Dictionary.<String, Object> ): Void

Sets the value of the key to the JSON object created from the provided Dictionary using fromDictionary.

setFloat ( key: String , value: Number ): Void

native

For a JSON Object, associates a 64-bit Float value with the provided key.

This value can be later retrieved with getFloat(key).

See also:
#getFloat()

setInteger ( key: String , value: Number ): Void

native

For a JSON Object, associates an Integer value with the provided key.

This value can be later retrieved with getInteger(key).

See also:
#getInteger()

setNumber ( key: String , value: Number ): Void

native

For a JSON Object, associates a 64-bit Float value with the provided key.

This value can be later retrieved with getNumber(key).

See also:
#getNumber()

setObject ( key: String , value: JSON ): Void

native

For a JSON Object, associates a JSON Object value with the provided key.

This value can be later retrieved with getObject(key).

See also:
#getObject()

setString ( key: String , value: String ): Void

native

For a JSON Object, associates a String value with the provided key.

This value can be later retrieved with getString(key).

See also:
#getString()

setValue ( key: String , o: Object ): Void

General function that sets the value of the key based on the type of object. Allowed datatypes are system.Boolean, system.Number, system.String, system.Vector, and system.Dictionary.

setVector ( key: String , v: Vector.<Object> ): Void

Sets the value of key to the JSON array created from the provided Vector using fromVector.

stringify ( o: Object , visited: Vector.<Object> = null ): String

static

Traverses through the object's fields and builds a JSON string from the hierarchy. If a dictionary is the object, or is included as part of the object, it must use a data type that can be converted into a string as its key identifier.

recursive looping.

toString (): String
Inherited from Object

native

Returns a String that describes the Object. This can be overriden to provide extra details when printing objects using trace().