getAll static method

Future<PcoCollection<PcoPeopleFieldDatum>> getAll({
  1. String? id,
  2. PcoPeopleFieldDatumQuery? query,
  3. bool includeAllRelated = false,
  4. bool includeFieldDefinition = false,
  5. bool includeFieldOption = false,
  6. bool includeTab = false,
})

Will get a PcoCollection containing ALL PcoPeopleFieldDatum objects (expecting many) using a path like this: /people/v2/field_data

Additional options may be specified by using the query argument, but some query options are also available as boolean flags in this function call too.

This function forces the query.getAll to be true.

Implementation

static Future<PcoCollection<PcoPeopleFieldDatum>> getAll({
  String? id,
  PcoPeopleFieldDatumQuery? query,
  bool includeAllRelated = false,
  bool includeFieldDefinition = false,
  bool includeFieldOption = false,
  bool includeTab = false,
}) async {
  query ??= PcoPeopleFieldDatumQuery();
  query.getAll = true;
  if (includeAllRelated) query.include.addAll(PcoPeopleFieldDatum.canInclude);
  if (includeFieldDefinition) query.include.add('field_definition');
  if (includeFieldOption) query.include.add('field_option');
  if (includeTab) query.include.add('tab');
  var url = '/people/v2/field_data';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeopleFieldDatum>(url,
      query: query, apiVersion: kApiVersion);
}