getAllFromHousehold static method
Will get a PcoCollection
containing ALL PcoPeopleHouseholdMembership objects (expecting many)
using a path like this: /people/v2/households/$householdId/household_memberships
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<PcoPeopleHouseholdMembership>>
getAllFromHousehold(
String householdId, {
String? id,
PcoPeopleHouseholdMembershipQuery? query,
bool includeAllRelated = false,
bool includeHousehold = false,
bool includePerson = false,
}) async {
query ??= PcoPeopleHouseholdMembershipQuery();
query.getAll = true;
if (includeAllRelated)
query.include.addAll(PcoPeopleHouseholdMembership.canInclude);
if (includeHousehold) query.include.add('household');
if (includePerson) query.include.add('person');
var url = '/people/v2/households/$householdId/household_memberships';
if (id != null) url += '/$id';
return PcoCollection.fromApiCall<PcoPeopleHouseholdMembership>(url,
query: query, apiVersion: kApiVersion);
}