getSingle static method

Future<PcoPeopleFieldDefinition?> getSingle(
  1. String id, {
  2. PcoPeopleFieldDefinitionQuery? query,
  3. bool includeAllRelated = false,
  4. bool includeFieldOptions = false,
  5. bool includeTab = false,
})

Will get a single PcoPeopleFieldDefinition object using a path like this: /people/v2/field_definitions/[id]

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.

Implementation

static Future<PcoPeopleFieldDefinition?> getSingle(
  String id, {
  PcoPeopleFieldDefinitionQuery? query,
  bool includeAllRelated = false,
  bool includeFieldOptions = false,
  bool includeTab = false,
}) async {
  query ??= PcoPeopleFieldDefinitionQuery();
  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/$id';
  var retval = await PcoCollection.fromApiCall<PcoPeopleFieldDefinition>(url,
      query: query, apiVersion: kApiVersion);
  return retval.items.isEmpty ? null : retval.items.first;
}