getAllFromFieldDefinition static method

Future<PcoCollection<PcoPeopleFieldOption>> getAllFromFieldDefinition(
  1. String fieldDefinitionId, {
  2. String? id,
  3. PcoPeopleFieldOptionQuery? query,
})

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

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<PcoPeopleFieldOption>> getAllFromFieldDefinition(
  String fieldDefinitionId, {
  String? id,
  PcoPeopleFieldOptionQuery? query,
}) async {
  query ??= PcoPeopleFieldOptionQuery();
  query.getAll = true;

  var url = '/people/v2/field_definitions/$fieldDefinitionId/field_options';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeopleFieldOption>(url,
      query: query, apiVersion: kApiVersion);
}