getSingleFromListCategory static method
Future<PcoPeopleList?>
getSingleFromListCategory(
- String listCategoryId,
- String id, {
- PcoPeopleListQuery? query,
- bool includeAllRelated = false,
- bool includeCampus = false,
- bool includeCategory = false,
- bool includeCreatedBy = false,
- bool includeMailchimpSyncStatus = false,
- bool includePeople = false,
- bool includeRules = false,
- bool includeUpdatedBy = false,
Will get a single PcoPeopleList
object
using a path like this: /people/v2/list_categories/$listCategoryId/lists/[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<PcoPeopleList?> getSingleFromListCategory(
String listCategoryId,
String id, {
PcoPeopleListQuery? query,
bool includeAllRelated = false,
bool includeCampus = false,
bool includeCategory = false,
bool includeCreatedBy = false,
bool includeMailchimpSyncStatus = false,
bool includePeople = false,
bool includeRules = false,
bool includeShares = false,
bool includeUpdatedBy = false,
}) async {
query ??= PcoPeopleListQuery();
if (includeAllRelated) query.include.addAll(PcoPeopleList.canInclude);
if (includeCampus) query.include.add('campus');
if (includeCategory) query.include.add('category');
if (includeCreatedBy) query.include.add('created_by');
if (includeMailchimpSyncStatus) query.include.add('mailchimp_sync_status');
if (includePeople) query.include.add('people');
if (includeRules) query.include.add('rules');
if (includeShares) query.include.add('shares');
if (includeUpdatedBy) query.include.add('updated_by');
var url = '/people/v2/list_categories/$listCategoryId/lists/$id';
var retval = await PcoCollection.fromApiCall<PcoPeopleList>(url,
query: query, apiVersion: kApiVersion);
return retval.items.isEmpty ? null : retval.items.first;
}