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

Throws InvalidIdException if scriptId or migratedFrom are not valid 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);
      }
    }

    if (identical(optimizeFor, OptimizeFor.post)) {
      if (!Validators.isValidScriptId(scriptId)) {
        throw InvalidIdException.withValue(scriptId);
      }

      if (!Validators.isValidIdV1(migratedFrom)) {
        throw InvalidIdException.withValue(migratedFrom);
      }
    }
  }

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

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

    if (isEnabled != _originalIsEnabled) {
      toReturn[ApiFields.isEnabled] = isEnabled;
    }

    if (!const DeepCollectionEquality.unordered()
        .equals(configuration, _originalConfiguration)) {
      toReturn[ApiFields.configuration] = configuration;
    }

    if (!const DeepCollectionEquality.unordered()
        .equals(trigger, _originalTrigger)) {
      toReturn[ApiFields.trigger] = trigger;
    }

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

    return toReturn;
  }

  // PUT FULL
  if (identical(optimizeFor, OptimizeFor.putFull)) {
    return {
      ApiFields.type: type.value,
      ApiFields.isEnabled: isEnabled,
      ApiFields.configuration: configuration,
      ApiFields.trigger: trigger,
      ApiFields.metadata: {ApiFields.name: name},
    };
  }

  // POST
  if (identical(optimizeFor, OptimizeFor.post)) {
    return {
      ApiFields.type: type,
      ApiFields.scriptId: scriptId,
      ApiFields.isEnabled: isEnabled,
      ApiFields.configuration: configuration,
      ApiFields.metadata: {ApiFields.name: name},
      ApiFields.migratedFrom: migratedFrom,
    };
  }

  // DEFAULT
  return {
    ApiFields.type: type.value,
    ApiFields.id: id,
    ApiFields.idV1: idV1,
    ApiFields.scriptId: scriptId,
    ApiFields.isEnabled: isEnabled,
    ApiFields.state: state,
    ApiFields.configuration: configuration,
    ApiFields.dependees: dependees
        .map((dependee) => dependee.toJson(optimizeFor: optimizeFor))
        .toList(),
    ApiFields.status: status,
    ApiFields.lastError: lastError,
    ApiFields.metadata: {ApiFields.name: name},
    ApiFields.migratedFrom: migratedFrom,
    ApiFields.trigger: trigger,
  };
}