PcoPeopleAddressQuery class Null safety

Possible Query Fields

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

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

whereCity: query on a specific city, example: ?wherecity=string
whereLocation: query on a specific location, example: ?wherelocation=string
wherePrimary: query on a specific primary, example: ?whereprimary=true
whereState: query on a specific state, example: ?wherestate=string
whereStreet: query on a specific street, example: ?wherestreet=string
whereZip: query on a specific zip, example: ?wherezip=string

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:

PcoPeopleAddressOrder.city : will order by city
PcoPeopleAddressOrder.createdAt : will order by created_at
PcoPeopleAddressOrder.location : will order by location
PcoPeopleAddressOrder.primary : will order by primary
PcoPeopleAddressOrder.state : will order by state
PcoPeopleAddressOrder.street : will order by street
PcoPeopleAddressOrder.updatedAt : will order by updated_at
PcoPeopleAddressOrder.zip : will order by zip

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

Object
PlanningCenterApiQuery
PcoPeopleAddressQuery

Constructors

PcoPeopleAddressQuery({String? whereCity, String? whereLocation, String? wherePrimary, String? whereState, String? whereStreet, String? whereZip, PcoPeopleAddressOrder? 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>: read-onlyinherited
asMap → Map<String, dynamic>: read-onlyinherited
extraParams ↔ Map<String, String>: extraParams allows you to specify arbitrary url parameters to the API.
read / writeinherited
filter ↔ Set<String>: filter should be something like future, past, after, before, no_dates
read / writeinherited
getAll ↔ bool: Set this flag to automatically retrieve all possible items for this query
read / writeinherited
hashCode → int: The hash code for this object.
read-onlyinherited
include ↔ Set<String>: include specifies which related items should be included.
read / writeinherited
order ↔ String?: order can usually be one of created_at, updated_at, title, sort_date, but may be others.
read / writeinherited
pageOffset ↔ int: read / writeinherited
perPage → int: Pagination defaults to 25, maximum allowed seems to be 100
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
read-onlyinherited
where ↔ List<PlanningCenterApiWhere>: where should be a map of query parameters.
read / writeinherited

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 non-existent 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