addSeries method

Future<SonarrSeries> addSeries({
  1. required int tvdbId,
  2. required int qualityProfileId,
  3. required String title,
  4. required List<SonarrSeriesImage> images,
  5. required List<SonarrSeriesSeason> seasons,
  6. required SonarrSeriesType seriesType,
  7. required int languageProfileId,
  8. required String rootFolderPath,
  9. SonarrMonitorType monitorMode = SonarrMonitorType.FUTURE,
  10. bool seasonFolder = true,
  11. bool monitored = true,
  12. bool searchForCutoffUnmetEpisodes = false,
  13. bool searchForMissingEpisodes = false,
})

Handler for series.

Adds a new series to your collection.

Required Parameters:

  • tvdbId: TVDB identifier for the series
  • profileId: Quality profile identifier
  • languageProfileId: Language profile identifier (if using Sonarr v2, pass null)
  • title: Title of the series
  • titleSlug: Title slug of the series
  • images: List of SonarrSeriesImage objects containing the image information
  • seasons: List of SonarrSeriesSeason objects containing the season information
  • path: Full path to where the series is located OR
  • rootFolderPath: Path to the root folder, where the folder will be created as the title
  • seriesType: The type of the series (anime, standard, or daily)

Optional Parameters:

  • tvRageId: TVRage identifier for the series
  • seasonFolder: Should this series use season folders?
  • monitored: Should this series be monitored?
  • ignoreEpisodesWithFiles: If true, automatically ignore episodes that already have episodes
  • searchForCutoffUnmetEpisodes: If true, automatically ignore episodes that do not have episodes
  • searchForMissingEpisodes: If true, start searching for all missing episodes after adding

Implementation

Future<SonarrSeries> addSeries({
  required int tvdbId,
  required int qualityProfileId,
  required String title,
  required List<SonarrSeriesImage> images,
  required List<SonarrSeriesSeason> seasons,
  required SonarrSeriesType seriesType,
  required int languageProfileId,
  required String rootFolderPath,
  SonarrMonitorType monitorMode = SonarrMonitorType.FUTURE,
  bool seasonFolder = true,
  bool monitored = true,
  bool searchForCutoffUnmetEpisodes = false,
  bool searchForMissingEpisodes = false,
}) async => _commandAddSeries(
  _client,
  tvdbId: tvdbId,
  qualityProfileId: qualityProfileId,
  languageProfileId: languageProfileId,
  title: title,
  images: images,
  seasons: seasons,
  rootFolderPath: rootFolderPath,
  seasonFolder: seasonFolder,
  monitored: monitored,
  seriesType: seriesType,
  monitorMode: monitorMode.value,
  searchForCutoffUnmetEpisodes: searchForCutoffUnmetEpisodes,
  searchForMissingEpisodes: searchForMissingEpisodes,
);