getSingleFromFieldDefinition static method

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

Will get a single PcoPeopleTab object using a path like this: /people/v2/field_definitions/$fieldDefinitionId/tab/[id]

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<PcoPeopleTab?> getSingleFromFieldDefinition(
  String fieldDefinitionId,
  String id, {
  PcoPeopleTabQuery? query,
  bool includeAllRelated = false,
  bool includeFieldDefinitions = false,
  bool includeFieldOptions = false,
}) async {
  query ??= PcoPeopleTabQuery();
  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/$id';
  var retval = await PcoCollection.fromApiCall<PcoPeopleTab>(url,
      query: query, apiVersion: kApiVersion);
  return retval.items.isEmpty ? null : retval.items.first;
}