PcoPeopleFieldDefinitionQuery class

Creates a PcoPeopleFieldDefinitionQuery object

Possible Includes

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

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

  • includeFieldOptions: include associated field_options
  • includeTab: include associated tab
  • includeAllRelated: include all related objects

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

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

Possible Query Fields

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

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

  • whereConfig: query on a specific config, example: ?whereconfig=string
  • whereDataType: query on a specific data_type, example: ?wheredata_type=string
  • whereDeletedAt: query on a specific deleted_at, example: ?wheredeleted_at=2000-01-01T12:00:00Z
  • whereName: query on a specific name, example: ?wherename=string
  • whereSequence: query on a specific sequence, example: ?wheresequence=1
  • whereSlug: query on a specific slug, example: ?whereslug=string
  • whereTabId: query on a specific tab_id, example: ?wheretab_id=primary_key

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:

  • PcoPeopleFieldDefinitionOrder.config : will order by config
  • PcoPeopleFieldDefinitionOrder.dataType : will order by data_type
  • PcoPeopleFieldDefinitionOrder.deletedAt : will order by deleted_at
  • PcoPeopleFieldDefinitionOrder.name : will order by name
  • PcoPeopleFieldDefinitionOrder.sequence : will order by sequence
  • PcoPeopleFieldDefinitionOrder.slug : will order by slug
  • PcoPeopleFieldDefinitionOrder.tabId : will order by tab_id

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

PcoPeopleFieldDefinitionQuery({bool includeFieldOptions = false, bool includeTab = false, bool includeAllRelated = false, String? whereConfig, String? whereDataType, String? whereDeletedAt, String? whereName, String? whereSequence, String? whereSlug, String? whereTabId, PcoPeopleFieldDefinitionFilter? filterBy, PcoPeopleFieldDefinitionOrder? 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