getSingle static method

Future<PcoPeopleNoteCategory?> getSingle(
  1. String id, {
  2. PcoPeopleNoteCategoryQuery? query,
  3. bool includeAllRelated = false,
  4. bool includeShares = false,
  5. bool includeSubscribers = false,
  6. bool includeSubscriptions = false,
})

Will get a single PcoPeopleNoteCategory object using a path like this: /people/v2/note_categories/[id]

Available Query Filters:

  • view_creatable

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<PcoPeopleNoteCategory?> getSingle(
  String id, {
  PcoPeopleNoteCategoryQuery? query,
  bool includeAllRelated = false,
  bool includeShares = false,
  bool includeSubscribers = false,
  bool includeSubscriptions = false,
}) async {
  query ??= PcoPeopleNoteCategoryQuery();
  if (includeAllRelated)
    query.include.addAll(PcoPeopleNoteCategory.canInclude);
  if (includeShares) query.include.add('shares');
  if (includeSubscribers) query.include.add('subscribers');
  if (includeSubscriptions) query.include.add('subscriptions');
  var url = '/people/v2/note_categories/$id';
  var retval = await PcoCollection.fromApiCall<PcoPeopleNoteCategory>(url,
      query: query, apiVersion: kApiVersion);
  return retval.items.isEmpty ? null : retval.items.first;
}