PcoPeoplePersonQuery class

Creates a PcoPeoplePersonQuery object

Possible Includes

(translates to url parameter: ?include=a,b)

Related data may be included by marking desired includeSomething variables as true:

  • includeAddresses: include associated addresses
  • includeEmails: include associated emails
  • includeFieldData: include associated field_data
  • includeHouseholds: include associated households
  • includeInactiveReason: include associated inactive_reason
  • includeMaritalStatus: include associated marital_status
  • includeNamePrefix: include associated name_prefix
  • includeNameSuffix: include associated name_suffix
  • includeOrganization: include associated organization
  • includePersonApps: include associated person_apps
  • includePhoneNumbers: include associated phone_numbers
  • includePlatformNotifications: include associated platform_notifications
  • includePrimaryCampus: include associated primary_campus
  • includeSchool: include associated school
  • includeSocialProfiles: include associated social_profiles
  • includeAllRelated: include all related objects

Alternatively, you may pass a list of strings to the include argument.

e.g. PcoPeoplePersonQuery(includes: ['a', 'b'])

Possible Query Fields

(translates to url parameters like ?where[field_name]=value or ?where[field_name][gt|lt]=value)

PcoPeoplePerson objects can be requested with one or more of the following criteria:

  • whereAccountingAdministrator: query on a specific accounting_administrator, example: ?whereaccounting_administrator=true
  • whereAnniversary: query on a specific anniversary, example: ?whereanniversary=2000-01-01
  • whereBirthdate: query on a specific birthdate, example: ?wherebirthdate=2000-01-01
  • whereChild: query on a specific child, example: ?wherechild=true
  • whereCreatedAt: query on a specific created_at, example: ?wherecreated_at=2000-01-01T12:00:00Z
  • whereFirstName: query on a specific first_name, example: ?wherefirst_name=string
  • whereGender: query on a specific gender, example: ?wheregender=string
  • whereGivenName: query on a specific given_name, example: ?wheregiven_name=string
  • whereGrade: query on a specific grade, example: ?wheregrade=1
  • whereGraduationYear: query on a specific graduation_year, example: ?wheregraduation_year=1
  • whereId: query on a specific id, example: ?whereid=primary_key
  • whereInactivatedAt: Set to an ISO 8601 date or time to make the profile inactive. Set to "null" to reactivate the profile., example: ?whereinactivated_at=2000-01-01T12:00:00Z
  • whereLastName: query on a specific last_name, example: ?wherelast_name=string
  • whereMedicalNotes: query on a specific medical_notes, example: ?wheremedical_notes=string
  • whereMembership: query on a specific membership, example: ?wheremembership=string
  • whereMiddleName: query on a specific middle_name, example: ?wheremiddle_name=string
  • whereNickname: query on a specific nickname, example: ?wherenickname=string
  • wherePeoplePermissions: query on a specific people_permissions, example: ?wherepeople_permissions=string
  • whereRemoteId: query on a specific remote_id, example: ?whereremote_id=1
  • whereSearchName: Search by Name (first, last, combination), example: ?wheresearch_name=string
  • whereSearchNameOrEmail: Search by Name (first, last, combination) or Email, example: ?wheresearch_name_or_email=string
  • whereSearchNameOrEmailOrPhoneNumber: Search by Name (first, last, combination), Email, or Phone Number, example: ?wheresearch_name_or_email_or_phone_number=string
  • whereSearchPhoneNumber: Search by Phone Number, example: ?wheresearch_phone_number=string
  • whereSearchPhoneNumberE164: Search by Phone Number E164, example: ?wheresearch_phone_number_e164=string
  • whereSiteAdministrator: query on a specific site_administrator, example: ?wheresite_administrator=true
  • whereStatus: Set to "inactive" to set "inactivated_at" to the current time and make the profile inactive. Set to anything else to clear "inactivated_at" and reactivate the profile., example: ?wherestatus=string
  • whereUpdatedAt: query on a specific updated_at, example: ?whereupdated_at=2000-01-01T12:00:00Z

For each, you may specify a prefix of <, <=, >, >= to query by comparisons

Alternatively, you may pass a List of PlanningCenterApiWhere objects to the where field e.g. PlanningCenterApiQuery(where: [PlanningCenterApiWhere('created_at', '2021-01-01', 'gte')]) See documentation for PlanningCenterApiQuery for more details about the where field.

Possible Ordering

(translates to url parameter: ?order=-updated_at)

Results can be ordered by setting orderBy to an appropriate enum value:

  • PcoPeoplePersonOrder.accountingAdministrator : will order by accounting_administrator
  • PcoPeoplePersonOrder.anniversary : will order by anniversary
  • PcoPeoplePersonOrder.birthdate : will order by birthdate
  • PcoPeoplePersonOrder.child : will order by child
  • PcoPeoplePersonOrder.createdAt : will order by created_at
  • PcoPeoplePersonOrder.firstName : will order by first_name
  • PcoPeoplePersonOrder.gender : will order by gender
  • PcoPeoplePersonOrder.givenName : will order by given_name
  • PcoPeoplePersonOrder.grade : will order by grade
  • PcoPeoplePersonOrder.graduationYear : will order by graduation_year
  • PcoPeoplePersonOrder.inactivatedAt : will order by inactivated_at
  • PcoPeoplePersonOrder.lastName : will order by last_name
  • PcoPeoplePersonOrder.membership : will order by membership
  • PcoPeoplePersonOrder.middleName : will order by middle_name
  • PcoPeoplePersonOrder.nickname : will order by nickname
  • PcoPeoplePersonOrder.peoplePermissions : will order by people_permissions
  • PcoPeoplePersonOrder.remoteId : will order by remote_id
  • PcoPeoplePersonOrder.siteAdministrator : will order by site_administrator
  • PcoPeoplePersonOrder.status : will order by status
  • PcoPeoplePersonOrder.updatedAt : will order by updated_at

To reverse the order, set reverse to true.

Alternatively, you may pass a string to the order field directly (a prefix of - reverses the order). e.g. PlanningCenterApiQuery(order: '-updated_at')

Extra Params

Many API queries accept extra parameters too. The extraParams mapping will translate directly to url parameters.

Inheritance

Constructors

PcoPeoplePersonQuery({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, bool includeAllRelated = false, String? whereAccountingAdministrator, String? whereAnniversary, String? whereBirthdate, String? whereChild, String? whereCreatedAt, String? whereFirstName, String? whereGender, String? whereGivenName, String? whereGrade, String? whereGraduationYear, String? whereId, String? whereInactivatedAt, String? whereLastName, String? whereMedicalNotes, String? whereMembership, String? whereMiddleName, String? whereNickname, String? wherePeoplePermissions, String? whereRemoteId, String? whereSearchName, String? whereSearchNameOrEmail, String? whereSearchNameOrEmailOrPhoneNumber, String? whereSearchPhoneNumber, String? whereSearchPhoneNumberE164, String? whereSiteAdministrator, String? whereStatus, String? whereUpdatedAt, PcoPeoplePersonFilter? filterBy, PcoPeoplePersonOrder? orderBy, bool reverse = false, int perPage = 25, int pageOffset = 0, Map<String, String> extraParams = const {}, List<PlanningCenterApiWhere>? where, Iterable<String> filter = const <String>[], String? order, Iterable<String> include = const <String>[]})

Properties

asApiMap → Map<String, dynamic>
no setterinherited
asMap → Map<String, dynamic>
no setterinherited
extraParams ↔ Map<String, String>
extraParams allows you to specify arbitrary url parameters to the API.
getter/setter pairinherited
filter ↔ Set<String>
filter should be something like future, past, after, before, no_dates
getter/setter pairinherited
getAll ↔ bool
Set this flag to automatically retrieve all possible items for this query
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
include ↔ Set<String>
include specifies which related items should be included.
getter/setter pairinherited
order ↔ String?
order can usually be one of created_at, updated_at, title, sort_date, but may be others.
getter/setter pairinherited
pageOffset ↔ int
getter/setter pairinherited
perPage → int
Pagination defaults to 25, maximum allowed seems to be 100
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
where ↔ List<PlanningCenterApiWhere>
where should be a map of query parameters.
getter/setter pairinherited

Methods

copy() → PlanningCenterApiQuery
returns a copy of this query as a new object this method works because Strings and ints are always copied by value
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
inherited
toString() → String
A string representation of this object.
inherited
withOffset(int offset) → PlanningCenterApiQuery
returns a new query only modifying the offset value
inherited

Operators

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

Static Methods

filterString(PcoPeoplePersonFilter filter) → String
orderString(PcoPeoplePersonOrder order, {bool reverse = false}) → String