Public classes


Scripts/

   JArray
   JBoolean
   JNull
   JNumber
   JSON
   JString
   JValue

Scripts/Attributes/

      ExcludeFromJSONSerializeAttribute
      IncludeToJSONSerializeAttribute

Scripts/Exceptions/

      DeserializeException
      JArgumentException
      JArgumentNullException
      JArrayIndexOutOfRangeException
      JNumberFormatException
      JNumberOverflowException
      JSONKeyAlreadyExistsException
      JSONKeyNotFoundException
      JValueNullException
      JValueTypeException
      ParseException
      ProtectedException
      SerializeException
      UnknownObjectTypeException

Scripts/Settings/

      CreateStringSettings
      DeserializeSettings
      ParseStringSettings
      SerializeSettings


Introduction page

DeserializeSettings


Settings for deserialization.


Properties

public bool AllowFieldsToBeObjectsBy default this is false.
public bool AllowNonStringDictionaryKeysBy default this is false.
public bool IgnoreSystemAndUnitySerializeAttributesBy default this is false.
public bool RequireAllFieldsArePopulatedDefault is true, meaning all the public fields in class/struct where JSON is deserialized must get their value set.
public bool RequireAllJSONValuesAreUsedDefault is false, meaning that any possible extra values in source JSON are ignored.

Properties

public bool AllowFieldsToBeObjects

By default this is false. Meaning that any fields where values are deserialized need to be exactly same type as JSON object. For example JBoolean goes only to bool, JString goes only to string, JSON goes only to Dictionary etc.

If this is set true, deserialization allows target fields also to be just objects (System.Object). Note however that in some cases deserialization may need to "guess" the correct type, for example if deserializing JNumber to object field ("10" can be either int, long, float or double).

ValueFalse by default, set true to allow more loose deserialization.


public bool AllowNonStringDictionaryKeys

By default this is false. Meaning that if any JSON object is deserialized to dictionary, target dictionary must be using string keys, like JSON itself is using.

If this is set true, dictionaries key type may also be integer or long. In this case deserialization try to change JSON keys to required dictionary key type. Note however that this may cause several problems when deserializing. For example, JSON object may contain keys "1" and "01". Deserializing this to Dictionary with string keys can be done without issues. But deserializing that JSON to Dictionary with integer keys causes error due duplicate key, even original JSON is completely valid.

ValueFalse by default, set true to allow more loose and flexible deserialization to dictionaries.


public bool IgnoreSystemAndUnitySerializeAttributes

By default this is false. Meaning that deserialization will check fields for UnityEngine.SerializeField and System.NonSerialized attributes and follow those.

In case these attributes are required for other uses but JSON deserialization should not follow these attributes, you can set this setting to true and those attributes will be ignored during JSON deserialization. You can still include/exclude single fields during deserialization using TotalJSON's own IncludeToJSONSerialize and ExcludeFromJSONSerialize attributes which are always followed regardless of this setting.

ValueFalse by default, set true to ignore non-json specific serialization attributes.


public bool RequireAllFieldsArePopulated

Default is true, meaning all the public fields in class/struct where JSON is deserialized must get their value set. So source JSON must contain matching values for all the fields.

If set to false, fields that have no matching data in JSON are just left in their default values.

For example, with default setting, deserializing JSON {"a":1,"b":2} to class { public int a; public int b; public int c; } will cause exception since there's no value for field 'c'.

ValueTrue by default, set false to allow classes/structs not to get fully populated.


public bool RequireAllJSONValuesAreUsed

Default is false, meaning that any possible extra values in source JSON are ignored. If set to true, it is strictly required that all the values from JSON must get used to populate some field in target class/struct.

For example, with default setting, deserializing JSON {"a":1,"b":2,"c":3} to class { public int a; public int b; } is acceptable and JSON value for 'c' is just not used.

ValueFalse by default, set true to require that everything in source JSON is used.