PcoPeopleTabQuery constructor

PcoPeopleTabQuery({
  1. bool includeFieldDefinitions = false,
  2. bool includeFieldOptions = false,
  3. bool includeAllRelated = false,
  4. String? whereName,
  5. String? whereSequence,
  6. String? whereSlug,
  7. PcoPeopleTabFilter? filterBy,
  8. PcoPeopleTabOrder? orderBy,
  9. bool reverse = false,
  10. int perPage = 25,
  11. int pageOffset = 0,
  12. Map<String, String> extraParams = const {},
  13. List<PlanningCenterApiWhere>? where,
  14. Iterable<String> filter = const <String>[],
  15. String? order,
  16. Iterable<String> include = const <String>[],
})

Implementation

PcoPeopleTabQuery({
  /// include associated field_definitions
  /// when true, adds `?include=field_definitions` to url
  bool includeFieldDefinitions = false,

  /// include associated field_options
  /// when true, adds `?include=field_options` to url
  bool includeFieldOptions = false,

  /// when true, adds `?include=field_definitions,field_options` to url parameters
  bool includeAllRelated = false,

  /// Query by `name`
  /// query on a specific name, url example: ?where[name]=string
  /// include a prefix of `<`, `<=`, `>`, `>=` to query by comparisons
  String? whereName,

  /// Query by `sequence`
  /// query on a specific sequence, url example: ?where[sequence]=1
  /// include a prefix of `<`, `<=`, `>`, `>=` to query by comparisons
  String? whereSequence,

  /// Query by `slug`
  /// query on a specific slug, url example: ?where[slug]=string
  /// include a prefix of `<`, `<=`, `>`, `>=` to query by comparisons
  String? whereSlug,
  PcoPeopleTabFilter? filterBy,
  PcoPeopleTabOrder? orderBy,

  /// reverse the ordering
  bool reverse = false,

  // direct access to super class params
  super.perPage,
  super.pageOffset,
  super.extraParams,
  super.where,
  super.filter,
  super.order,
  super.include,
}) : super() {
  if (filterBy != null) filter.add(filterString(filterBy));
  if (includeAllRelated || includeFieldDefinitions)
    include.add('field_definitions');
  if (includeAllRelated || includeFieldOptions) include.add('field_options');

  if (whereName != null)
    where.add(PlanningCenterApiWhere.parse('name', whereName));
  if (whereSequence != null)
    where.add(PlanningCenterApiWhere.parse('sequence', whereSequence));
  if (whereSlug != null)
    where.add(PlanningCenterApiWhere.parse('slug', whereSlug));

  if (orderBy != null) order = orderString(orderBy, reverse: reverse);
}