getFromTab static method

Future<PcoCollection<PcoPeopleFieldDefinition>> getFromTab(
  1. String tabId,
  2. {String? id,
  3. PcoPeopleFieldDefinitionQuery? query,
  4. bool getAll = false,
  5. bool includeAllRelated = false,
  6. bool includeFieldOptions = false,
  7. bool includeTab = false}
)

Will get a PcoCollection of PcoPeopleFieldDefinition objects (expecting many) using a path like this: /people/v2/tabs/$tabId/field_definitions

Available Query Filters:

  • with_deleted

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<PcoPeopleFieldDefinition>> getFromTab(
  String tabId, {
  String? id,
  PcoPeopleFieldDefinitionQuery? query,
  bool getAll = false,
  bool includeAllRelated = false,
  bool includeFieldOptions = false,
  bool includeTab = false,
}) async {
  query ??= PcoPeopleFieldDefinitionQuery();
  if (getAll) 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/tabs/$tabId/field_definitions';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeopleFieldDefinition>(url,
      query: query, apiVersion: kApiVersion);
}