getAllFromFormAndFormSubmission static method

Future<PcoCollection<PcoPeopleFormField>> getAllFromFormAndFormSubmission(
  1. String formId,
  2. String formSubmissionId, {
  3. String? id,
  4. PcoPeopleFormFieldQuery? query,
  5. bool includeOptions = false,
})

Will get a PcoCollection containing ALL PcoPeopleFormField objects (expecting many) using a path like this: /people/v2/forms/$formId/form_submissions/$formSubmissionId/form_fields

Additional options may be specified by using the query argument, but some query options are also available as boolean flags in this function call too.

This function forces the query.getAll to be true.

Implementation

static Future<PcoCollection<PcoPeopleFormField>>
    getAllFromFormAndFormSubmission(
  String formId,
  String formSubmissionId, {
  String? id,
  PcoPeopleFormFieldQuery? query,
  bool includeOptions = false,
}) async {
  query ??= PcoPeopleFormFieldQuery();
  query.getAll = true;

  if (includeOptions) query.include.add('options');
  var url =
      '/people/v2/forms/$formId/form_submissions/$formSubmissionId/form_fields';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeopleFormField>(url,
      query: query, apiVersion: kApiVersion);
}