getSingleFromPerson static method

Future<PcoPeopleMessage?> getSingleFromPerson(
  1. String personId,
  2. String id, {
  3. PcoPeopleMessageQuery? query,
  4. bool includeAllRelated = false,
  5. bool includeMessageGroup = false,
  6. bool includeTo = false,
})

Will get a single PcoPeopleMessage object using a path like this: /people/v2/people/$personId/messages/[id]

Available Query Filters:

  • created_after
  • received
  • sent
  • unread

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<PcoPeopleMessage?> getSingleFromPerson(
  String personId,
  String id, {
  PcoPeopleMessageQuery? query,
  bool includeAllRelated = false,
  bool includeMessageGroup = false,
  bool includeTo = false,
}) async {
  query ??= PcoPeopleMessageQuery();
  if (includeAllRelated) query.include.addAll(PcoPeopleMessage.canInclude);
  if (includeMessageGroup) query.include.add('message_group');
  if (includeTo) query.include.add('to');
  var url = '/people/v2/people/$personId/messages/$id';
  var retval = await PcoCollection.fromApiCall<PcoPeopleMessage>(url,
      query: query, apiVersion: kApiVersion);
  return retval.items.isEmpty ? null : retval.items.first;
}