public JSON ()

Creates new empty JSON object.

public JSON (IDictionary sourceKeysAndValues)

Creates new JSON object from c# dictionary. Note that values in dictionary need to be basic c# objects like string, booleans, numbers, or another dictionaries or lists. To turn other classes to JSON object, or for more flexible options, consider using static JSON.Serialize() method.

public JValue this [string key]

Gets or sets the value specified by key. Setting value can do both adding new value or replacing old one with same key.

public int Count

Gets the count of key/value pairs in this JSON.

public string[] Keys

Gets all the keys in this JSON object. You can use this to loop through all the keys in this json, for example:
foreach (string key in json.Keys) {...}

Array of returned string keys is copy of internal dictionary keys of this JSON object. This means you can add or remove values from this JSON while looping through the keys. For example:

foreach (string key in json.Keys) {
  if (ShouldRemove(key)) {
    json.Remove(key);
  }
}


public void Add (string key, object value)

Add new key/value pair to this JSON. This method will prevent accidental overwriting old values with same key. If there already is key/value pair with same key, this method will throw an exception.

public void AddOrReplace (string key, object value)

Add or replace key/value pair in this JSON. Possible previous value with same key is replaced.

public Dictionary AsDictionary ()

Gets the whole JSON object as system dictionary. This is recursive, so if this JSON contains other JSON objects or lists, those will be also changed to system objects.

public void Clear ()

Remove all the key/value pairs from this JSON, leaving it empty.

public bool ContainsKey (string keyToSearch)

Check whatever this JSON object contains key/value pair with specified key.

public string CreatePrettyString ()

Turns this JSON object to JSON formatted, but easily human readable string. This output is not as tightly packed as string returned by CreateString() but contains all the same data and is still completely valid JSON.

This method is just a shortcut for doing:

CreateStringSettings createStringSettings = new CreateStringSettings();
createStringSettings.HumanReadable = true;
string output = CreateString(createStringSettings);


public override string CreateString ()

Turns this JSON object to single JSON formatted string that can be easily stored or sent to another system. String always starts with character '{' and ends to character '}' and contains no linefeeds.

Note that for large JSON objects output may be also very long. For debugging purposes, consider also .

public override string CreateString (CreateStringSettings settings)

Turns this JSON object to single JSON formatted string using specified settings.

public void DebugInEditor (string debugName)

Adds this JSON object to editor debug window so content of JSON object can be followed in Unity editor when application is running. Choose "Window" -> "Total JSON" -> "JSON Runtime Debug" from Unity editor menu top open this window.

Calling this method outside Unity editor doesn't do anything.

public T Deserialize<T> ()

Deserialize this JSON to object, using default settings.

Typically this is used as opposite operation for Serialize. After Serialize is used to turn object to JSON, this method can be used to turn JSON back to object of same type.

public T Deserialize<T> (DeserializeSettings deserializeSettings)

Deserialize this JSON to object, using specified settings.

Typically this is used as opposite operation for Serialize. After Serialize is used to turn object to JSON, this method can be used to turn JSON back to object of same type.

public override bool Equals (object anotherObject)

Test if another object equals to this object. Always returns false if parameter object is null or it is not instance of JSON. Two JSON objects are equal if both contains same keys and every element mapped to each key equals to each other.

Note that string representation generated using CreateString() may not have identical output from two JSON objects that still equals. This is because key-value pairs may be in different order when they are written to string.

public JValue Get (string key)

Gets value specified by key. This method will cause exception if key/value pair doesn't exist. Returned value may be JSON, JString, JNumber, JBoolean, JArray or JNull.

public bool GetBool (string key)

Gets c# bool value specified by key. This method will cause exception if key/value pair doesn't exist or value is not boolean.

public float GetFloat (string key)

Gets floating point number specified by key. This method will cause exception if key/value pair doesn't exist, value is not number or it is outside float range.

This method is for convenience. It is equal to json.GetJNumber(key).AsFloat();
If there is need to get number value from JSON in some very specific format, use GetJNumber(key) and
then methods provided by JNumber class, for example json.GetJNumber(key).AsDecimal();

public int GetInt (string key)

Gets integer number specified by key. This method will cause exception if key/value pair doesn't exist, value is not number or it is outside int range.

This method is for convenience. It is equal to json.GetJNumber(key).AsInt();
If there is need to get number value from JSON in some very specific format, use GetJNumber(key) and
then methods provided by JNumber class, for example json.GetJNumber(key).AsULong();

public JArray GetJArray (string key)

Gets JArray specified by key. This method will cause exception if key/value pair doesn't exist or value is anything else than JArray or JNull.

public JNumber GetJNumber (string key)

Gets JNumber value specified by key. This method will cause exception if key/value pair doesn't exist or value is anything else than JNumber or JNull.

public JSON GetJSON (string key)

Gets JSON value specified by key. This method will cause exception if key/value pair doesn't exist or value is anything else than JSON or JNull.

public string GetString (string key)

Gets string value specified by key. This method will cause exception if key/value pair doesn't exist or value is anything else than JString or JNull.

public bool IsJNull (string key)

Check if value specified by key is JNull. This method throws exception if key doesn't exist.

public bool IsProtected ()

Check whatever this JSON is protected (read only). If it is, it also means that all its childen are protected, but nothing can be assumed of parents of this object.

public void Remove (string key)

Remove value specified by key. This method throws exception if key doesn't exist.

public void Replace (string key, object value)

Replace existing key/value pair in this JSON. If there isn't key/value pair with same key, this method will throw an exception.

public void SetDebugIDForExceptions (string debugIdForExceptions)

Sets debug ID for this JSON object. This ID is added to any possible exception messages that may occur when handling this JSON.

This is typically useful in production builds where only exception message is logged but full stacktrace may not be available. Settings this debug ID helps to identify which JSON object caused exception.

Note that if this JSON object was parsed from string and ParseStringSettings.DebugIDForExceptions for already set during parse, that same ID is copied to this JSON object.

public void SetProtected ()

Sets this JSON and all its childen protected (read only). New values can't be added and old values replaced or removed.

Typically this is called only for top level JSON. Protecetion can't be cancelled, once it is set, it will stay.

public override string ToString ()

Returns compact information of this JSON object as string, for debug purposes.

When you want to get all content of this JSON object in JSON formatted string, use .

public static JSON ParseString (string jsonObjectAsSingleString)

Turns JSON formatted string to new JSON object.

public static JSON ParseString (string jsonObjectAsSingleString, string debugIDForExceptions)

Turns JSON formatted string to new JSON object. Debug ID is added to any possible exceptions that may occur during parse or when handling resulting JSON object afterwards.

This method is for convenience. This method will create new ParseStringSettings object and set value for DebugIDForExceptions,
then call ParseString(string jsonObjectAsSingleString, ParseStringSettings parseStringSettings) method. See ParseStringSettings class for more information.

public static JSON ParseString (string jsonObjectAsSingleString, ParseStringSettings parseStringSettings)

Turns JSON formatted string to new JSON object, using specified settings.

public static JSON[] ParseStringToMultiple (string multipleJsonObjectsAsSingleString)

Turns single string to multiple new JSON objects. Source string may contain any amount of JSON objects, including zero.

Acceptable input string are for example:
'' (empty string, returns JSON array with length of 0)
'{"hello":"world"}' (returns JSON array with length of 1, normal ParseString method could be used to this one too)
'{}{} {}' (returns JSON array of length 3, all JSON objects in array are empty)

public static JSON[] ParseStringToMultiple (string multipleJsonObjectsAsSingleString, ParseStringSettings parseStringSettings)

Turns single string to multiple new JSON objects, using specified settings. Source string may contain any amount of JSON objects, including zero.

public static JSON Serialize (object objectToSerialize)

Serialize object to JSON object, using default settings.

If parameter object is class or struct, only public fields or fields marked with [SerializeField] are serialized.

public static JSON Serialize (object objectToSerialize, SerializeSettings serializeSettings)

Serialize object to JSON object, using specific settings.

If parameter object is class or struct, only public fields or fields marked with [SerializeField] are serialized.