PcoPeopleFieldOption constructor

PcoPeopleFieldOption(
  1. {required String fieldDefinitionId,
  2. String? id,
  3. String? value,
  4. int? sequence,
  5. Map<String, List<PcoResource>>? withRelationships,
  6. List<PcoResource>? withIncluded}
)

Create a new PcoPeopleFieldOption object using this endpoint: https://api.planningcenteronline.com/people/v2/field_definitions/$fieldDefinitionId/field_options

NOTES:

  • Creating an instance of a class this way does not save it on the server.
  • Call save() on the object to save it to the server.
  • Only set the id field if you know what you are doing. Save operations will overwrite data when the id is set.
  • Dummy data can be supplied for a required parameter, but if so, .save() should not be called on the object
  • FIELDS USED WHEN CREATING: value, sequence
  • FIELDS USED WHEN UPDATING: value, sequence

Implementation

factory PcoPeopleFieldOption(
    {required String fieldDefinitionId,
    String? id,
    String? value,
    int? sequence,
    Map<String, List<PcoResource>>? withRelationships,
    List<PcoResource>? withIncluded}) {
  var obj = PcoPeopleFieldOption.empty();
  obj._id = id;
  obj._apiPathOverride =
      'https://api.planningcenteronline.com/people/v2/field_definitions/$fieldDefinitionId/field_options';
  if (value != null) obj._attributes['value'] = value;
  if (sequence != null) obj._attributes['sequence'] = sequence;

  if (withRelationships != null) {
    for (var r in withRelationships.entries) {
      obj._relationships[r.key] = r.value;
    }
    obj._hasManualRelationships = true;
  }

  if (withIncluded != null) {
    obj._included.addAll(withIncluded);
    obj._hasManualIncluded = true;
  }

  return obj;
}