getSharesFromWorkflow static method

Future<PcoCollection<PcoPeopleWorkflowShare>> getSharesFromWorkflow(
  1. String workflowId, {
  2. PcoPeopleWorkflowShareQuery? query,
  3. bool getAll = false,
  4. bool includePerson = false,

Will get a PcoCollection of PcoPeopleWorkflowShare objects (expecting one) using a path like this: /people/v2/workflows/$workflowId/shares

Getting a PcoCollection is useful even when retrieving a single object because it contains error data and helper functions.

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.


static Future<PcoCollection<PcoPeopleWorkflowShare>> getSharesFromWorkflow(
  String workflowId, {
  PcoPeopleWorkflowShareQuery? query,
  bool getAll = false,
  bool includePerson = false,
}) async {
  query ??= PcoPeopleWorkflowShareQuery();
  if (getAll) query.getAll = true;

  if (includePerson) query.include.add('person');
  var url = '/people/v2/workflows/$workflowId/shares';

  return PcoCollection.fromApiCall<PcoPeopleWorkflowShare>(url,
      query: query, apiVersion: kApiVersion);