toJson method

@override Map<String, dynamic> toJson({ 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.

Throws GradientException if points has is not in the proper range. It must either have 0 elements or between 2 and 5 (inclusive), and optimizeFor is not set to OptimizeFor.dontOptimize.

Throws InvalidValueException if mode is empty and optimizeFor is not set to OptimizeFor.dontOptimize.

Implementation

@override
Map<String, dynamic> toJson({OptimizeFor optimizeFor = OptimizeFor.put}) {
  // Super JSON
  Map<String, dynamic> superJson = super.toJson(optimizeFor: optimizeFor);

  // PUT & PUT FULL
  if (identical(optimizeFor, OptimizeFor.put) ||
      identical(optimizeFor, OptimizeFor.putFull)) {
    return superJson;
  }

  // DEFAULT
  return {
    ...superJson,
    ...{
      ApiFields.pointsCapable: pointsCapable,
      ApiFields.modeValues: modeValues,
      ApiFields.pixelCount: pixelCount,
    },
  };
}