getSingleFromSong static method

Future<PcoServicesArrangement?> getSingleFromSong(
  1. String songId,
  2. String id, {
  3. PcoServicesArrangementQuery? query,
  4. bool includeAllRelated = false,
  5. bool includeKeys = false,
  6. bool includeSections = false,
})

Will get a single PcoServicesArrangement object using a path like this: /services/v2/songs/$songId/arrangements/[id]

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<PcoServicesArrangement?> getSingleFromSong(
  String songId,
  String id, {
  PcoServicesArrangementQuery? query,
  bool includeAllRelated = false,
  bool includeKeys = false,
  bool includeSections = false,
}) async {
  query ??= PcoServicesArrangementQuery();
  if (includeAllRelated)
    query.include.addAll(PcoServicesArrangement.canInclude);
  if (includeKeys) query.include.add('keys');
  if (includeSections) query.include.add('sections');
  var url = '/services/v2/songs/$songId/arrangements/$id';
  var retval = await PcoCollection.fromApiCall<PcoServicesArrangement>(url,
      query: query, apiVersion: kApiVersion);
  return retval.items.isEmpty ? null : retval.items.first;
}