getFromFieldDefinition static method

Future<PcoCollection<PcoPeopleTab>> getFromFieldDefinition(
  1. String fieldDefinitionId,
  2. {String? id,
  3. PcoPeopleTabQuery? query,
  4. bool getAll = false,
  5. bool includeAllRelated = false,
  6. bool includeFieldDefinitions = false,
  7. bool includeFieldOptions = false}
)

Will get a PcoCollection of PcoPeopleTab objects (expecting many) using a path like this: /people/v2/field_definitions/$fieldDefinitionId/tab

Getting a PcoCollection is useful even when retrieving a single object because it contains error data and helper functions.

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.

Implementation

static Future<PcoCollection<PcoPeopleTab>> getFromFieldDefinition(
  String fieldDefinitionId, {
  String? id,
  PcoPeopleTabQuery? query,
  bool getAll = false,
  bool includeAllRelated = false,
  bool includeFieldDefinitions = false,
  bool includeFieldOptions = false,
}) async {
  query ??= PcoPeopleTabQuery();
  if (getAll) 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_definitions/$fieldDefinitionId/tab';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeopleTab>(url,
      query: query, apiVersion: kApiVersion);
}