getFromFieldData static method
Will get a PcoCollection
of PcoPeopleFieldDefinition objects (expecting one)
using a path like this: /people/v2/field_data/$fieldDataId/field_definition
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>> getFromFieldData(
String fieldDataId, {
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/field_data/$fieldDataId/field_definition';
return PcoCollection.fromApiCall<PcoPeopleFieldDefinition>(url,
query: query, apiVersion: kApiVersion);
}