getFromTeam static method

Future<PcoCollection<PcoServicesPersonTeamPositionAssignment>> getFromTeam(
  1. String teamId, {
  2. String? id,
  3. PcoServicesPersonTeamPositionAssignmentQuery? query,
  4. bool getAll = false,
  5. bool includeAllRelated = false,
  6. bool includePerson = false,
  7. bool includeTeamPosition = false,
})

Will get a PcoCollection of PcoServicesPersonTeamPositionAssignment objects (expecting many) using a path like this: /services/v2/teams/$teamId/person_team_position_assignments

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.

Implementation

static Future<PcoCollection<PcoServicesPersonTeamPositionAssignment>>
    getFromTeam(
  String teamId, {
  String? id,
  PcoServicesPersonTeamPositionAssignmentQuery? query,
  bool getAll = false,
  bool includeAllRelated = false,
  bool includePerson = false,
  bool includeTeamPosition = false,
}) async {
  query ??= PcoServicesPersonTeamPositionAssignmentQuery();
  if (getAll) query.getAll = true;
  if (includeAllRelated)
    query.include.addAll(PcoServicesPersonTeamPositionAssignment.canInclude);
  if (includePerson) query.include.add('person');
  if (includeTeamPosition) query.include.add('team_position');
  var url = '/services/v2/teams/$teamId/person_team_position_assignments';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoServicesPersonTeamPositionAssignment>(
      url,
      query: query,
      apiVersion: kApiVersion);
}