getAllFromMessageGroup static method

Future<PcoCollection<PcoPeopleMessage>> getAllFromMessageGroup(String messageGroupId, { String? id, PcoPeopleMessageQuery? query, bool includeAllRelated = false, bool includeMessageGroup = false, bool includeTo = false, })

Will get a PcoCollection containing ALL PcoPeopleMessage objects (expecting many) using a path like this: /people/v2/message_groups/$messageGroupId/messages

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<PcoPeopleMessage>> getAllFromMessageGroup(
  String messageGroupId, {
  String? id,
  PcoPeopleMessageQuery? query,
  bool includeAllRelated = false,
  bool includeMessageGroup = false,
  bool includeTo = false,
}) async {
  query ??= PcoPeopleMessageQuery();
  query.getAll = true;
  if (includeAllRelated) query.include.addAll(PcoPeopleMessage.canInclude);
  if (includeMessageGroup) query.include.add('message_group');
  if (includeTo) query.include.add('to');
  var url = '/people/v2/message_groups/$messageGroupId/messages';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeopleMessage>(url,
      query: query, apiVersion: kApiVersion);
}