PlanningCenterApiQuery class

PlanningCenterApiQuery objects handle all the additional API parameters accepted by the Planning Center API.

Implementers

Constructors

PlanningCenterApiQuery({int perPage = 25, int pageOffset = 0, bool getAll = false, String? order, List<PlanningCenterApiWhere>? where, Iterable<String> filter = const <String>[], Iterable<String> include = const <String>[], Map<String, String> extraParams = const {}})

Properties

asApiMap → Map<String, dynamic>
no setter
asMap → Map<String, dynamic>
no setter
extraParams ↔ Map<String, String>
extraParams allows you to specify arbitrary url parameters to the API.
getter/setter pair
filter ↔ Set<String>
filter should be something like future, past, after, before, no_dates
getter/setter pair
getAll ↔ bool
Set this flag to automatically retrieve all possible items for this query
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
include ↔ Set<String>
include specifies which related items should be included.
getter/setter pair
order ↔ String?
order can usually be one of created_at, updated_at, title, sort_date, but may be others.
getter/setter pair
pageOffset ↔ int
getter/setter pair
perPage → int
Pagination defaults to 25, maximum allowed seems to be 100
final
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 pair

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
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited
withOffset(int offset) → PlanningCenterApiQuery
returns a new query only modifying the offset value

Operators

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