toJson method

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

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 InvalidNameException if name doesn't have a length of 1 - 32 (inclusive) and optimizeFor is not set to OptimizeFor.dontOptimize.

Implementation

@override
Map<String, dynamic> toJson({OptimizeFor optimizeFor = OptimizeFor.put}) {
  /// Validate data.
  if (!identical(optimizeFor, OptimizeFor.dontOptimize)) {
    if (!Validators.isValidName(name)) {
      if (!identical(optimizeFor, OptimizeFor.put) || name != _originalName) {
        throw InvalidNameException.withValue(name);
      }
    }
  }

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

    if (type != originalType) {
      toReturn[ApiFields.type] = type.value;
    }

    if (name != _originalName) {
      toReturn[ApiFields.name] = name;
    }

    if (isAtHome != _originalIsAtHome) {
      toReturn[ApiFields.isAtHome] = isAtHome;
    }

    return toReturn;
  }

  // PUT FULL & POST
  if (identical(optimizeFor, OptimizeFor.putFull) ||
      identical(optimizeFor, OptimizeFor.post)) {
    return {
      ApiFields.type: type,
      ApiFields.name: name,
      ApiFields.isAtHome: isAtHome,
    };
  }

  // DEFAULT
  return {
    ApiFields.type: type.value,
    ApiFields.id: id,
    ApiFields.idV1: idV1,
    ApiFields.name: name,
    ApiFields.isAtHome: isAtHome,
  };
}