getAllFromFieldData static method

Future<PcoCollection<PcoPeopleTab>> getAllFromFieldData(String fieldDataId, { String? id, PcoPeopleTabQuery? query, bool includeAllRelated = false, bool includeFieldDefinitions = false, bool includeFieldOptions = false, })

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

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<PcoPeopleTab>> getAllFromFieldData(
  String fieldDataId, {
  String? id,
  PcoPeopleTabQuery? query,
  bool includeAllRelated = false,
  bool includeFieldDefinitions = false,
  bool includeFieldOptions = false,
}) async {
  query ??= PcoPeopleTabQuery();
  query.getAll = true;
  if (includeAllRelated) query.include.addAll(PcoPeopleTab.canInclude);
  if (includeFieldDefinitions) query.include.add('field_definitions');
  if (includeFieldOptions) query.include.add('field_options');
  var url = '/people/v2/field_data/$fieldDataId/tab';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeopleTab>(url,
      query: query, apiVersion: kApiVersion);
}