getFromFieldData static method
Will get a PcoCollection
of PcoPeopleTab objects (expecting many)
using a path like this: /people/v2/field_data/$fieldDataId/tab
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<PcoPeopleTab>> getFromFieldData(
String fieldDataId, {
String? id,
PcoPeopleTabQuery? query,
bool getAll = false,
bool includeAllRelated = false,
bool includeFieldDefinitions = false,
bool includeFieldOptions = false,
}) async {
query ??= PcoPeopleTabQuery();
if (getAll) 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/field_data/$fieldDataId/tab';
if (id != null) url += '/$id';
return PcoCollection.fromApiCall<PcoPeopleTab>(url,
query: query, apiVersion: kApiVersion);
}