toJson method

Map<String, dynamic> toJson({
  1. OptimizeFor optimizeFor = OptimizeFor.put,
})

Converts this object into JSON format.

optimizeFor lets the program know what information to include in the JSON data map.

  • OptimizeFor.put (the default value) is used when making a data map that is being placed in a PUT request. This only includes data that has changed.
  • OptimizeFor.putFull is used when a parent object updates; so, all of the children are required to be present for the PUT request.
  • OptimizeFor.post is used when making a data map for a POST request.
  • OptimizeFor.dontOptimize is used to get all of the data contained in this object.

Implementation

Map<String, dynamic> toJson({OptimizeFor optimizeFor = OptimizeFor.put}) {
  // PUT
  if (identical(optimizeFor, OptimizeFor.put)) {
    Map<String, dynamic> toReturn = {};

    if (!const DeepCollectionEquality.unordered()
        .equals(colors, _originalColors)) {
      toReturn[ApiFields.color] = colors
          .map((color) => color.toJson(optimizeFor: OptimizeFor.putFull))
          .toList();
    }

    if (!const DeepCollectionEquality.unordered()
        .equals(dimmings, _originalDimmings)) {
      toReturn[ApiFields.dimming] = dimmings
          .map((d) => d.toJson(optimizeFor: OptimizeFor.putFull))
          .toList();
    }

    if (!const DeepCollectionEquality.unordered()
        .equals(colorTemperatures, _originalColorTemperatures)) {
      toReturn[ApiFields.colorTemperature] = colorTemperatures
          .map((ct) => ct.toJson(optimizeFor: OptimizeFor.putFull))
          .toList();
    }

    return toReturn;
  }

  // DEFAULT
  return {
    ApiFields.color: colors
        .map((color) => color.toJson(
            optimizeFor: identical(optimizeFor, OptimizeFor.dontOptimize)
                ? optimizeFor
                : OptimizeFor.putFull))
        .toList(),
    ApiFields.dimming: dimmings
        .map((d) => d.toJson(
            optimizeFor: identical(optimizeFor, OptimizeFor.dontOptimize)
                ? optimizeFor
                : OptimizeFor.putFull))
        .toList(),
    ApiFields.colorTemperature: colorTemperatures
        .map((ct) => ct.toJson(
            optimizeFor: identical(optimizeFor, OptimizeFor.dontOptimize)
                ? optimizeFor
                : OptimizeFor.putFull))
        .toList(),
  };
}