getFromHousehold static method
Future<PcoCollection<PcoPeoplePerson> >
getFromHousehold(
- String householdId, {
- String? id,
- PcoPeoplePersonQuery? query,
- bool getAll = false,
- bool includeAllRelated = false,
- bool includeAddresses = false,
- bool includeEmails = false,
- bool includeFieldData = false,
- bool includeHouseholds = false,
- bool includeInactiveReason = false,
- bool includeMaritalStatus = false,
- bool includeNamePrefix = false,
- bool includeNameSuffix = false,
- bool includeOrganization = false,
- bool includePersonApps = false,
- bool includePhoneNumbers = false,
- bool includePlatformNotifications = false,
- bool includePrimaryCampus = false,
- bool includeSchool = false,
- bool includeSocialProfiles = false,
Will get a PcoCollection
of PcoPeoplePerson objects (expecting many)
using a path like this: /people/v2/households/$householdId/people
Available Query Filters:
non_pending
without_deceased
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<PcoPeoplePerson>> getFromHousehold(
String householdId, {
String? id,
PcoPeoplePersonQuery? query,
bool getAll = false,
bool includeAllRelated = false,
bool includeAddresses = false,
bool includeEmails = false,
bool includeFieldData = false,
bool includeHouseholds = false,
bool includeInactiveReason = false,
bool includeMaritalStatus = false,
bool includeNamePrefix = false,
bool includeNameSuffix = false,
bool includeOrganization = false,
bool includePersonApps = false,
bool includePhoneNumbers = false,
bool includePlatformNotifications = false,
bool includePrimaryCampus = false,
bool includeSchool = false,
bool includeSocialProfiles = false,
}) async {
query ??= PcoPeoplePersonQuery();
if (getAll) query.getAll = true;
if (includeAllRelated) query.include.addAll(PcoPeoplePerson.canInclude);
if (includeAddresses) query.include.add('addresses');
if (includeEmails) query.include.add('emails');
if (includeFieldData) query.include.add('field_data');
if (includeHouseholds) query.include.add('households');
if (includeInactiveReason) query.include.add('inactive_reason');
if (includeMaritalStatus) query.include.add('marital_status');
if (includeNamePrefix) query.include.add('name_prefix');
if (includeNameSuffix) query.include.add('name_suffix');
if (includeOrganization) query.include.add('organization');
if (includePersonApps) query.include.add('person_apps');
if (includePhoneNumbers) query.include.add('phone_numbers');
if (includePlatformNotifications)
query.include.add('platform_notifications');
if (includePrimaryCampus) query.include.add('primary_campus');
if (includeSchool) query.include.add('school');
if (includeSocialProfiles) query.include.add('social_profiles');
var url = '/people/v2/households/$householdId/people';
if (id != null) url += '/$id';
return PcoCollection.fromApiCall<PcoPeoplePerson>(url,
query: query, apiVersion: kApiVersion);
}