PcoPeopleHousehold class

This class represents a PCO People Household Object

Instantiation

  • Create a new instance using the PcoPeopleHousehold() constructor
  • Instantiate from existing JSON data using the PcoPeopleHousehold.fromJson() constructor.
  • Load an instance from the API using one of the static methods defined on this class.

Usage

  • Fields exposed by the API are readable through getter methods.
  • Fields writable by the API are exposed through setter methods.
  • Original json data is exposed through the read-only attributes map.
  • Additional data is available through the read-only links and relationships maps.
  • Available relationships / includes are exposed through typed getters.

Extra Instructions

CREATING

To create a new household, you must specify the primary contact and the people as relationships: {"data":{"attributes":{"name":"Smith"},"relationships":{"people":{"data":[{"type":"Person","id":"1"},{"type":"Person","id":"2"}]},"primary_contact":{"data":{"type":"Person","id":"1"}}}}}

Description

A household links people together and can have a primary contact. To add a person to an existing household, use the HouseholdMemberships endpoint.

Attributes (and permissions)

  • id (ro) -> PCO: id
  • name (rw) -> PCO: name
  • memberCount (rw) -> PCO: member_count
  • primaryContactName (ro) -> PCO: primary_contact_name
  • createdAt (ro) -> PCO: created_at
  • updatedAt (ro) -> PCO: updated_at
  • avatar (rw) -> PCO: avatar
  • primaryContactId (rw) -> PCO: primary_contact_id

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "Household",
  "id": "1",
  "attributes": {
    "name": "string",
    "member_count": 1,
    "primary_contact_name": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z",
    "avatar": "string",
    "primary_contact_id": "primary_key"
  },
  "relationships": {
    "primary_contact": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "people": {
      "data": [
        {
          "type": "Person",
          "id": "1"
        }
      ]
    }
  }
}
Inheritance

Constructors

PcoPeopleHousehold({String? id, String? name, int? memberCount, String? primaryContactName, DateTime? createdAt, DateTime? updatedAt, String? avatar, String? primaryContactId, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoPeopleHousehold object using this endpoint: https://api.planningcenteronline.com/people/v2/households
factory
PcoPeopleHousehold.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoPeopleHousehold.fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded})

Properties

api → PlanningCenter
planning center resources must be tied to an api
no setterinherited
apiEndpoint → String
no setterinherited
apiPath → String
PcoResources include their own path as a link object but this might be null if we haven't created/fetched the object yet Child classes should redefine this getter to allow for manual path overrides
no setteroverride
apiVersion → String
child classes can override these getters which will allow methods in this class to see static variables from child classes
no setteroverride
attributes → ReadOnlyMapView<String, dynamic>
contains the underlying attributes returned by the api and allows a user to access arbitrary data in the attributes by actual api name
no setterinherited
avatar ↔ String
pass null to remove key from attributes
getter/setter pair
canCreate → bool
no setteroverride
canDestroy → bool
no setteroverride
canUpdate → bool
no setteroverride
createAllowed → List<String>
no setteroverride
createdAt → DateTime
no setterinherited
createPathTemplate → String
no setteroverride
defaultPathTemplate → String
no setteroverride
fetched ↔ bool
indicate whether an item is full or partial
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String?
no setterinherited
included → List<PcoResource>
contains included items parsed into objects
no setterinherited
includedPeople → List<PcoPeoplePerson>
no setter
contains the links data returned by the api if present
no setterinherited
memberCount ↔ int
pass null to remove key from attributes
getter/setter pair
name ↔ String
pass null to remove key from attributes
getter/setter pair
needsSave → bool
no setterinherited
pcoApplication ↔ String
latefinalinherited
primaryContactId ↔ String
pass null to remove key from attributes
getter/setter pair
primaryContactName → String
no setter
relationships → ReadOnlyMapView<String, List<PcoResource>>
contains relationships parsed into objects even though the api sends relationship objects as Maps or Lists we always put them into lists for consistency
no setterinherited
resourceType ↔ String
all planning center resources must have a type
latefinalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
slug → String
no setterinherited
updateAllowed → List<String>
no setteroverride
updatedAt → DateTime
no setterinherited

Methods

coerceDouble(dynamic a) → double
inherited
coerceInt(dynamic a) → int
inherited
delete() → Future<PlanningCenterApiResponse<PlanningCenterApiData>>
inherited
filteredAttributes(List<String> allowedKeys) → Map<String, dynamic>
inherited
fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded}) → dynamic
Takes a full JSON:API Response Object (the contents of a "data" field) will clear and update id, apiPath, attributes and _relationships
inherited
getHouseholdMemberships({PcoPeopleHouseholdMembershipQuery? query}) → Future<PcoCollection<PcoPeopleHouseholdMembership>>
Will get a collection of PcoPeopleHouseholdMembership objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/households/1/household_memberships
getPeople({PcoPeoplePersonQuery? query}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a collection of PcoPeoplePerson objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/households/1/people
handleIncludes(List<Map<String, dynamic>> included) → void
This function populates the relationships with typed resource objects based on the data in the included map of the json.
inherited
handleItem(Map<String, dynamic> data) → PcoResource?
inherited
handleRelationships(Map<String, dynamic> items, [List<Map<String, dynamic>> included = const []]) → Map<String, List<PcoResource>>
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
save({Map<String, PcoResource>? withRelated, List<PcoResource>? withIncluded}) → Future<PlanningCenterApiResponse<PlanningCenterApiData>>
Many Planning Center endpoints allow or require additional relationships and/or included items to be sent with a create/update operation. Since these cannot always be determined by the automatic code generation, they may be included as arguments to the save operation.
inherited
toCreateResource() → Map<String, dynamic>
create the attributes Map for this object without the id field using only the attributes allowed in create (post) operations
inherited
toDataMap({Map<String, PcoResource>? withRelated, List<PcoResource>? withIncluded}) → Map<String, dynamic>
create a json-api Map for this object automatically selecting create or update based on the existence of the id field. Will result in something like this:
inherited
toIdResource() → Map<String, dynamic>
returns the simplest representation of this resource with only the type and the id:
inherited
toJson({dynamic includeAttributes = true, dynamic includeRelationships = false}) → Map<String, dynamic>
Some api requests only want the type and id of an object. In those cases, set includeAttributes to false or call toIdResource instead.
inherited
toString() → String
A string representation of this object.
inherited
toUpdateResource() → Map<String, dynamic>
create the attributes Map for this object using only the attributes allowed in update (patch) operations
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

canInclude → List<String>
possible includes with parameter ?include=a,b
no setter
canOrderBy → List<String>
possible orderings with parameter ?order=
no setter
canQuery → List<String>
possible queries using parameters like ?wherekey=value or ?wheregt|lt=value
no setter

Static Methods

get({String? id, PcoPeopleHouseholdQuery? query, bool getAll = false, bool includePeople = false}) → Future<PcoCollection<PcoPeopleHousehold>>
Will get a PcoCollection of PcoPeopleHousehold objects (expecting many) using a path like this: /people/v2/households
getAll({String? id, PcoPeopleHouseholdQuery? query, bool includePeople = false}) → Future<PcoCollection<PcoPeopleHousehold>>
Will get a PcoCollection containing ALL PcoPeopleHousehold objects (expecting many) using a path like this: /people/v2/households
getAllFromPerson(String personId, {String? id, PcoPeopleHouseholdQuery? query, bool includePeople = false}) → Future<PcoCollection<PcoPeopleHousehold>>
Will get a PcoCollection containing ALL PcoPeopleHousehold objects (expecting many) using a path like this: /people/v2/people/$personId/households
getFromHouseholdAndHouseholdMembership(String householdId, String householdMembershipId, {PcoPeopleHouseholdQuery? query, bool getAll = false, bool includePeople = false}) → Future<PcoCollection<PcoPeopleHousehold>>
Will get a PcoCollection of PcoPeopleHousehold objects (expecting one) using a path like this: /people/v2/households/$householdId/household_memberships/$householdMembershipId/household
getFromPeopleImportAndHistory(String peopleImportId, String historyId, {PcoPeopleHouseholdQuery? query, bool getAll = false, bool includePeople = false}) → Future<PcoCollection<PcoPeopleHousehold>>
Will get a PcoCollection of PcoPeopleHousehold objects (expecting one) using a path like this: /people/v2/people_imports/$peopleImportId/histories/$historyId/household
getFromPerson(String personId, {String? id, PcoPeopleHouseholdQuery? query, bool getAll = false, bool includePeople = false}) → Future<PcoCollection<PcoPeopleHousehold>>
Will get a PcoCollection of PcoPeopleHousehold objects (expecting many) using a path like this: /people/v2/people/$personId/households
getSingle(String id, {PcoPeopleHouseholdQuery? query, bool includePeople = false}) → Future<PcoPeopleHousehold?>
Will get a single PcoPeopleHousehold object using a path like this: /people/v2/households/[id]
getSingleFromPerson(String personId, String id, {PcoPeopleHouseholdQuery? query, bool includePeople = false}) → Future<PcoPeopleHousehold?>
Will get a single PcoPeopleHousehold object using a path like this: /people/v2/people/$personId/households/[id]

Constants

kApiVersion → const String
kAvatar → const String
kCreatedAt → const String
kCreatePathTemplate → const String
kDefaultPathTemplate → const String
kId → const String
kMemberCount → const String
kName → const String
kPcoApplication → const String
kPrimaryContactId → const String
kPrimaryContactName → const String
kTypeId → const String
kTypeString → const String
kUpdatedAt → const String