getAll static method

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

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

Available Query Filters:

  • with_field_definitions

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