PcoPeopleWorkflowShareQuery class

Creates a PcoPeopleWorkflowShareQuery object

Possible Includes

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

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

  • includePerson: include associated person
  • includeAllRelated: include all related objects

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

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

Possible Query Fields

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

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

  • wherePermission: query on a specific permission, example: ?wherepermission=value

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.

Extra Params

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

Inheritance

Constructors

PcoPeopleWorkflowShareQuery({bool includePerson = false, String? wherePermission, 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(PcoPeopleWorkflowShareFilter filter) → String
orderString(PcoPeopleWorkflowShareOrder order, {bool reverse = false}) → String