getAll static method

Future<PcoCollection<PcoPeopleFieldDefinition>> getAll({ String? id, PcoPeopleFieldDefinitionQuery? query, bool includeAllRelated = false, bool includeFieldOptions = false, bool includeTab = false, })

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

Available Query Filters:

• include_deleted By default, deleted fields are not included. Pass filter=include_deleted to include them.

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