SonarrAPI class abstract

Annotations

• @RestApi.new()

Constructors

SonarrAPI(SonarrConfig config)

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

bulkDeleteSeries(SonarrSeriesEditorOptions options, {CancelToken? cancelToken}) → Future<void>

Bulk delete a batch of series using the editor.

bulkEditSeries(SonarrSeriesEditorOptions options, {CancelToken? cancelToken}) → Future<void>

Bulk edit a batch of series using the editor.

cancelCommand(int id, {CancelToken? cancelToken}) → Future<void>

Cancel a queued command.

createCustomFilter(SonarrCustomFilter filter, {CancelToken? cancelToken}) → Future<SonarrCustomFilter>

Create a new custom filter.

createCustomFormat(SonarrCustomFormat format, {CancelToken? cancelToken}) → Future<SonarrCustomFormat>

Create a new custom format.

createDelayProfile(SonarrDelayProfile profile, {CancelToken? cancelToken}) → Future<SonarrDelayProfile>

Create a new delay profile.

createDownloadClient(SonarrDownloadClient client, {CancelToken? cancelToken}) → Future<SonarrDownloadClient>

Create a new download client.

createImportList(SonarrImportList list, {CancelToken? cancelToken}) → Future<SonarrImportList>

Create a new import list.

createImportListExclusion(SonarrImportListExclusion exclusion, {CancelToken? cancelToken}) → Future<SonarrImportListExclusion>

Create a new import list exclusion.

createIndexer(SonarrIndexer indexer, {CancelToken? cancelToken}) → Future<SonarrIndexer>

Create a new indexer.

createLanguageProfile(SonarrLanguageProfile profile, {CancelToken? cancelToken}) → Future<SonarrLanguageProfile>

Create a new language profile.

createMetadataAgent(SonarrMetadataAgent metadata, {CancelToken? cancelToken}) → Future<SonarrMetadataAgent>

Create a new metadata agent.

createNotificationAgent(SonarrNotification notification, {CancelToken? cancelToken}) → Future<SonarrNotification>

Create a new notification agent.

createQualityProfile(SonarrQualityProfile profile, {CancelToken? cancelToken}) → Future<SonarrQualityProfile>

Create a new quality profile.

createReleaseProfile(SonarrReleaseProfile profile, {CancelToken? cancelToken}) → Future<SonarrReleaseProfile>

Create a new release profile.

createRemotePathMapping(SonarrRemotePathMapping mapping, {CancelToken? cancelToken}) → Future<SonarrRemotePathMapping>

Create a new remote path mapping.

createRootFolder(SonarrRootFolder rootFolder, {CancelToken? cancelToken}) → Future<SonarrRootFolder>

Create a new root folder.

createSeries(SonarrSeries series, {CancelToken? cancelToken}) → Future<SonarrSeries>

Create a new series.

createTag(SonarrTag tag, {CancelToken? cancelToken}) → Future<SonarrTag>

Create a new tag.

deleteBackup(int id, {CancelToken? cancelToken}) → Future<void>

Delete a system backup by ID.

deleteBlocklistItem(int id, {CancelToken? cancelToken}) → Future<void>

Delete a blocklist item.

deleteBlocklistItems(SonarrBlocklistBulkOptions options, {CancelToken? cancelToken}) → Future<HttpResponse<void>>

Delete a blocklist item.

deleteCustomFilter(int id, {CancelToken? cancelToken}) → Future<void>

Delete a custom filter.

deleteCustomFormat(int id, {CancelToken? cancelToken}) → Future<void>

Delete a custom format.

deleteDelayProfile(int id, {CancelToken? cancelToken}) → Future<void>

Delete a delay profile.

deleteDownloadClient(int id, {CancelToken? cancelToken}) → Future<void>

Delete a download client.

deleteEpisodeFile(int id, {CancelToken? cancelToken}) → Future<void>

Delete an episode file.

deleteEpisodeFiles(SonarrEpisodeEditorOptions options, {CancelToken? cancelToken}) → Future<void>

Delete a group of episode files.

deleteImportList(int id, {CancelToken? cancelToken}) → Future<void>

Delete a import list.

deleteImportListExclusion(int id, {CancelToken? cancelToken}) → Future<void>

Delete a import list exclusion.

deleteIndexer(int id, {CancelToken? cancelToken}) → Future<void>

Delete a indexer.

deleteLanguageProfile(int id, {CancelToken? cancelToken}) → Future<void>

Delete a language profile.

deleteMetadataAgent(int id, {CancelToken? cancelToken}) → Future<void>

Delete a metadata agent.

deleteNotificationAgent(int id, {CancelToken? cancelToken}) → Future<void>

Delete a notification agent.

deleteQualityProfile(int id, {CancelToken? cancelToken}) → Future<void>

Delete a quality profile.

deleteQueueItem(int id, {bool blocklist = false, bool removeFromClient = true, CancelToken? cancelToken}) → Future<void>

Delete a queue item.

deleteQueueItems(SonarrQueueBulkOptions options, {bool blocklist = false, bool removeFromClient = true, CancelToken? cancelToken}) → Future<void>

Delete a batch of queue items.

deleteReleaseProfile(int id, {CancelToken? cancelToken}) → Future<void>

Delete a release profile.

deleteRemotePathMapping(int id, {CancelToken? cancelToken}) → Future<void>

Delete a remote path mapping.

deleteRootFolder(int id, {CancelToken? cancelToken}) → Future<void>

Delete a root folder.

deleteSeries(int id, {bool? deleteFiles, bool? addImportListExclusion, CancelToken? cancelToken}) → Future<void>

Delete a series.

deleteTag(int id, {CancelToken? cancelToken}) → Future<void>

Delete a tag.

downloadRelease(SonarrRelease release, {CancelToken? cancelToken}) → Future<SonarrRelease>

Trigger a download of the given release.

editEpisodeFiles(SonarrEpisodeEditorOptions options, {CancelToken? cancelToken}) → Future<List<SonarrEpisodeFile>>

Edit (editor-style) a group of episode files.

getAllSeries({int? tmdbId, CancelToken? cancelToken}) → Future<List<SonarrSeries>>

Get a list of all added series.

getBackups({CancelToken? cancelToken}) → Future<List<SonarrBackup>>

Get a list of all system backups.

getBannerImage(int seriesId, SonarrImageSizeBanner size, {CancelToken? cancelToken}) → Future<List<int>>

Get a poster image from Sonarr's media cover cache.

getBlocklist({int? page, int? pageSize, String? sortKey, SonarrSortDirection? sortDirection, CancelToken? cancelToken}) → Future<SonarrPagedResult<SonarrBlocklist>>

Get all entries from the blocklist.

getCalendar({bool? unmonitored, bool? includeSeries, bool? includeEpisodeFile, bool? includeEpisodeImages, DateTime? endDate, DateTime? startDate, CancelToken? cancelToken}) → Future<List<SonarrEpisode>>

Get items from the calendar.

getCommand(int id, {CancelToken? cancelToken}) → Future<SonarrCommand>

Get a single command by ID.

getCommands({CancelToken? cancelToken}) → Future<List<SonarrCommand>>

Get a list of recently run commands.

getCustomFilter(int id, {CancelToken? cancelToken}) → Future<SonarrCustomFilter>

Get a single custom filter by ID.

getCustomFilters({CancelToken? cancelToken}) → Future<List<SonarrCustomFilter>>

Get a list of all created custom filters.

getCustomFormat(int id, {CancelToken? cancelToken}) → Future<SonarrCustomFormat>

Get a single custom format by ID.

getCustomFormats({CancelToken? cancelToken}) → Future<List<SonarrCustomFormat>>

Get a list of all created custom formats.

getCustomFormatSchemas({CancelToken? cancelToken}) → Future<List<SonarrCustomFormatSchema>>

Get all schemas for the available custom formats.

getCutoffUnmetEpisode(int id, {CancelToken? cancelToken}) → Future<SonarrEpisode>

Get a cutoff unmet episode by ID.

getCutoffUnmetEpisodes({int? page, int? pageSize, String? sortKey, SonarrSortDirection? sortDirection, bool includeEpisodeFile = false, bool includeImages = false, bool includeSeries = false, CancelToken? cancelToken}) → Future<SonarrPagedResult<SonarrEpisode>>

Get a list of cutoff unmet episodes.

getDelayProfile(int id, {CancelToken? cancelToken}) → Future<SonarrDelayProfile>

Get a single delay profile by ID.

getDelayProfiles({CancelToken? cancelToken}) → Future<List<SonarrDelayProfile>>

Get a list of all created delay profiles.

getDiskSpace({CancelToken? cancelToken}) → Future<List<SonarrDiskSpace>>

Get a list of disk spaces.

getDownloadClient(int id, {CancelToken? cancelToken}) → Future<SonarrDownloadClient>

Get a single download client by ID.

getDownloadClientConfig({CancelToken? cancelToken}) → Future<SonarrDownloadClientConfig>

Get the download client configuration.

getDownloadClients({CancelToken? cancelToken}) → Future<List<SonarrDownloadClient>>

Get a list of all added download clients.

getDownloadClientSchemas({CancelToken? cancelToken}) → Future<List<SonarrDownloadClient>>

Get all schemas for the available download clients.

getEpisode(int id, {CancelToken? cancelToken}) → Future<SonarrEpisode>

Get a single episode by ID.

getEpisodeFile(int id, {CancelToken? cancelToken}) → Future<SonarrEpisodeFile>

Get a single episode file by ID.

getEpisodeFiles({int? seriesId, List<int>? episodeFileIds, CancelToken? cancelToken}) → Future<List<SonarrEpisodeFile>>

Get a list of episode files.

getEpisodeRenamePreview(int seriesId, {int? seasonNumber, CancelToken? cancelToken}) → Future<List<SonarrEpisodeRenamePreview>>

Get a preview of results for renaming an episode file.

getEpisodes({int? seriesId, int? seasonNumber, List<int>? episodeIds, int? episodeFileId, bool includeImages = false, CancelToken? cancelToken}) → Future<List<SonarrEpisode>>

Get a list of episodes.

getFanartImage(int seriesId, SonarrImageSizeFanart size, {CancelToken? cancelToken}) → Future<List<int>>

Get a fanart image from Sonarr's media cover cache.

getFileSystem({String? path, bool? includeFiles, bool? allowFoldersWithoutTrailingSlashes, CancelToken? cancelToken}) → Future<SonarrFileSystem>

Get details about directories and files in the filesystem.

getFileSystemMediaFiles(String path, {CancelToken? cancelToken}) → Future<List<SonarrFileSystemMediaFile>>

Get a list of all media files at the given path in the filesystem.

getFileSystemType(String path, {CancelToken? cancelToken}) → Future<SonarrFileSystemType>

Get the type of the entity at the given path in the filesystem.

getHealth({CancelToken? cancelToken}) → Future<List<SonarrHealth>>

Get all current health messages.

getHistory({int? page, int? pageSize, String? sortKey, SonarrSortDirection? sortDirection, bool? includeSeries = false, bool? includeEpisode = false, int? eventType, String? downloadId, int? episodeId, CancelToken? cancelToken}) → Future<SonarrPagedResult<SonarrHistory>>

Get a list of history entries.

getHistorySince(DateTime date, {SonarrHistoryEventType? eventType, bool? includeSeries = false, bool? includeEpisode = false, CancelToken? cancelToken}) → Future<List<SonarrHistory>>

Get all history since the date given.

getHostConfig({CancelToken? cancelToken}) → Future<SonarrHostConfig>

Get the host configuration.

getImportList(int id, {CancelToken? cancelToken}) → Future<SonarrImportList>

Get a single import list by ID.

getImportListExclusion(int id, {CancelToken? cancelToken}) → Future<SonarrImportListExclusion>

Get a single import list exclusion by ID.

getImportListExclusions({CancelToken? cancelToken}) → Future<List<SonarrImportListExclusion>>

Get a list of all added import list exclusions.

getImportLists({CancelToken? cancelToken}) → Future<List<SonarrImportList>>

Get a list of all added import lists.

getImportListSchemas({CancelToken? cancelToken}) → Future<List<SonarrImportList>>

Get all schemas for the available import lists.

getIndexer(int id, {CancelToken? cancelToken}) → Future<SonarrIndexer>

Get a single indexer by ID.

getIndexerConfig({CancelToken? cancelToken}) → Future<SonarrIndexerConfig>

Get the indexer configuration.

getIndexers({CancelToken? cancelToken}) → Future<List<SonarrIndexer>>

Get a list of all added indexers.

getIndexerSchemas({CancelToken? cancelToken}) → Future<List<SonarrIndexer>>

Get all schemas for the available indexers.

getLanguage(int id, {CancelToken? cancelToken}) → Future<SonarrLanguage>

Get a single language by ID.

getLanguageProfile(int id, {CancelToken? cancelToken}) → Future<SonarrLanguageProfile>

Get a single language profile by ID.

getLanguageProfiles({CancelToken? cancelToken}) → Future<List<SonarrLanguageProfile>>

Get a list of all added language profiles.

getLanguageProfileSchema({CancelToken? cancelToken}) → Future<SonarrLanguageProfile>

Get all schemas for the available language profiles.

getLanguages({CancelToken? cancelToken}) → Future<List<SonarrLanguage>>

Get a list of all available languages.

getLogFileData(String name, {CancelToken? cancelToken}) → Future<List<int>>

Get a specific log file data.

getLogFiles({CancelToken? cancelToken}) → Future<List<SonarrLogFile>>

Get a list of log files.

getLogs({int? page, int? pageSize, String? sortKey, SonarrSortDirection? sortDirection, SonarrLogLevel? level, CancelToken? cancelToken}) → Future<SonarrPagedResult<SonarrLog>>

Get a list of logs.

getManualImport({String? folder, String? downloadId, int? seriesId, int? seasonNumber, bool filterExistingFiles = true, CancelToken? cancelToken}) → Future<List<SonarrManualImport>>

Get the results for a manual import from the filesystem.

getMediaManagementConfig({CancelToken? cancelToken}) → Future<SonarrMediaManagementConfig>

Get the media management configuration.

getMetadataAgent(int id, {CancelToken? cancelToken}) → Future<SonarrMetadataAgent>

Get a single metadata agent by ID.

getMetadataAgents({CancelToken? cancelToken}) → Future<List<SonarrMetadataAgent>>

Get a list of all added metadata agents.

getMetadataAgentSchemas({CancelToken? cancelToken}) → Future<List<SonarrMetadataAgent>>

Get all schemas for the available metadata agents.

getMissingEpisode(int id, {CancelToken? cancelToken}) → Future<SonarrEpisode>

Get a missing episode by ID.

getMissingEpisodes({int? page, int? pageSize, String? sortKey, SonarrSortDirection? sortDirection, bool includeImages = false, bool includeSeries = false, CancelToken? cancelToken}) → Future<SonarrPagedResult<SonarrEpisode>>

Get a list of missing episodes

getNamingConfig({CancelToken? cancelToken}) → Future<SonarrNamingConfig>

Get the naming configuration.

getNamingConfigExamples({bool? renameEpisodes, bool? replaceIllegalCharacters, int? multiEpisodeStyle, String? standardEpisodeFormat, String? dailyEpisodeFormat, String? animeEpisodeFormat, String? seriesFolderFormat, String? seasonFolderFormat, String? specialsFolderFormat, bool? includeSeriesTitle, bool? includeEpisodeTitle, bool? includeQuality, bool? replaceSpaces, String? separator, String? numberStyle, int? id, CancelToken? cancelToken}) → Future<SonarrNamingConfigExamples>

Get example formats from the naming configuration.

getNotificationAgent(int id, {CancelToken? cancelToken}) → Future<SonarrNotification>

Get a single notification agent by ID.

getNotificationAgents({CancelToken? cancelToken}) → Future<List<SonarrNotification>>

Get a list of all added notification agents.

getNotificationAgentSchemas({CancelToken? cancelToken}) → Future<List<SonarrNotification>>

Get all schemas for the available notification agents.

getPosterImage(int seriesId, SonarrImageSizePoster size, {CancelToken? cancelToken}) → Future<List<int>>

Get a poster image from Sonarr's media cover cache.

getQualityDefinition(int id, {CancelToken? cancelToken}) → Future<SonarrQualityDefinition>

Get a single quality definition by ID.

getQualityDefinitions({CancelToken? cancelToken}) → Future<List<SonarrQualityDefinition>>

Get a list of all quality definitions.

getQualityProfile(int id, {CancelToken? cancelToken}) → Future<SonarrQualityProfile>

Get a single quality profile by ID.

getQualityProfiles({CancelToken? cancelToken}) → Future<List<SonarrQualityProfile>>

Get a list of all added quality profiles.

getQualityProfileSchema({CancelToken? cancelToken}) → Future<SonarrQualityProfile>

Get all schemas for the available quality profiles.

getQueue({int? page, int? pageSize, String? sortKey, SonarrSortDirection? sortDirection, bool? includeSeries = false, bool? includeEpisode = false, bool? includeUnknownSeriesItems = false, CancelToken? cancelToken}) → Future<SonarrPagedResult<SonarrQueue>>

Get all entries from the queue.

getQueueDetails({int? seriesId, List<int>? episodeIds, bool? includeSeries = false, bool? includeEpisode = false, CancelToken? cancelToken}) → Future<List<SonarrQueue>>

Get queue items with the ability to filter by series or episode IDs.

getQueueStatus({CancelToken? cancelToken}) → Future<SonarrQueueStatus>

Get the status of the queue.

getReleaseProfile(int id, {CancelToken? cancelToken}) → Future<SonarrReleaseProfile>

Get a single release profile by ID.

getReleaseProfiles({CancelToken? cancelToken}) → Future<List<SonarrReleaseProfile>>

Get a list of all created release profiles.

getReleases(int seriesId, {int? episodeId, int? seasonNumber, CancelToken? cancelToken}) → Future<List<SonarrRelease>>

Get a list of releases for a series by episode ID or season number.

getRemotePathMapping(int id, {CancelToken? cancelToken}) → Future<SonarrRemotePathMapping>

Get a single remote path mapping by ID.

getRemotePathMappings({CancelToken? cancelToken}) → Future<List<SonarrRemotePathMapping>>

Get a list of all created remote path mappings.

getRootFolder(int id, {CancelToken? cancelToken}) → Future<SonarrRootFolder>

Get a single root folder by ID.

getRootFolders({CancelToken? cancelToken}) → Future<List<SonarrRootFolder>>

Get a list of all created root folders.

getSeries(int id, {CancelToken? cancelToken}) → Future<SonarrSeries>

Get a single series by ID.

getSeriesHistory(int seriesId, {int? seasonNumber, SonarrHistoryEventType? eventType, bool? includeSeries = false, bool? includeEpisode = false, CancelToken? cancelToken}) → Future<List<SonarrHistory>>

Get all history for a given series by ID.

getSystemStatus({CancelToken? cancelToken}) → Future<SonarrSystemStatus>

Get system status information.

getTag(int id, {CancelToken? cancelToken}) → Future<SonarrTag>

Get a single tag by ID.

getTagDetails(int id, {CancelToken? cancelToken}) → Future<SonarrTagDetails>

Get detailed information about a single tag by ID.

getTags({CancelToken? cancelToken}) → Future<List<SonarrTag>>

Get a list of all created tags.

getTagsDetails({CancelToken? cancelToken}) → Future<List<SonarrTagDetails>>

Get detailed information about all created tags.

getTask(int id, {CancelToken? cancelToken}) → Future<SonarrTask>

Get a single system task by ID.

getTasks({CancelToken? cancelToken}) → Future<List<SonarrTask>>

Get a list of all system tasks.

getUiConfig({CancelToken? cancelToken}) → Future<SonarrUiConfig>

Get the UI configuration.

getUpdateLogFileData(String name, {CancelToken? cancelToken}) → Future<List<int>>

Get a specific update log file data.

getUpdateLogFiles({CancelToken? cancelToken}) → Future<List<SonarrLogFile>>

Get a list of update log files.

getUpdates({CancelToken? cancelToken}) → Future<List<SonarrUpdate>>

Get a list of Sonarr updates.

grabQueueItem(int id, {CancelToken? cancelToken}) → Future<void>

Grab a queue item.

grabQueueItems(SonarrQueueBulkOptions options, {CancelToken? cancelToken}) → Future<void>

Grab a batch of queue items.

lookupSeries(String term, {CancelToken? cancelToken}) → Future<List<SonarrSeries>>

Lookup a list of series by term.

markHistoryAsFailed(int id, {CancelToken? cancelToken}) → Future<void>

Mark a history entry as failed.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

parseEpisodeTitle({String? title, String? path, CancelToken? cancelToken}) → Future<SonarrParse>

Review the results of parsing an episode title.

reprocessManualImport(List<SonarrManualImportReprocess> reprocess, CancelToken? cancelToken) → Future<List<SonarrManualImportReprocess>>

Reprocess files for manual import given new parameters.

restartInstance({CancelToken? cancelToken}) → Future<void>

Restart the instance of Sonarr.

restoreBackup(int id, {CancelToken? cancelToken}) → Future<void>

Restore a system backup by ID.

setSeasonPass(SonarrSeasonPass seasonPass, {CancelToken? cancelToken}) → Future<void>

Set season pass.

shutdownInstance({CancelToken? cancelToken}) → Future<void>

Shutdown the instance of Sonarr.

testAllDownloadClients({CancelToken? cancelToken}) → Future<List<SonarrDownloadClientTestResult>>

Test all added download client configurations.

testAllImportLists({CancelToken? cancelToken}) → Future<List<SonarrImportListTestResult>>

Test all added import list configurations.

testAllIndexers({CancelToken? cancelToken}) → Future<List<SonarrIndexerTestResult>>

Test all added indexer configurations.

testAllNotificationAgents({CancelToken? cancelToken}) → Future<List<SonarrNotificationTestResult>>

Test all added notification agent configurations.

testDownloadClient(SonarrDownloadClient client, {CancelToken? cancelToken}) → Future<List<SonarrDownloadClientValidationFailure>>

Test a single download client configuration.

testImportList(SonarrImportList list, {CancelToken? cancelToken}) → Future<List<SonarrImportListValidationFailure>>

Test a single import list configuration.

testIndexer(SonarrIndexer indexer, {CancelToken? cancelToken}) → Future<void>

Test a single indexer configuration.

testNotificationAgent(SonarrNotification notification, {CancelToken? cancelToken}) → Future<List<SonarrNotificationValidationFailure>>

Test a single notification agent configuration.

toString() → String

A string representation of this object.

inherited

triggerCommandApplicationUpdate({SonarrCommandApplicationUpdate body = const SonarrCommandApplicationUpdate(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Application Update" command.

triggerCommandApplicationUpdateCheck({SonarrCommandApplicationUpdateCheck body = const SonarrCommandApplicationUpdateCheck(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Application Update Check" command.

triggerCommandCheckForFinishedDownload({SonarrCommandCheckForFinishedDownload body = const SonarrCommandCheckForFinishedDownload(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Check for Finished Download" command.

triggerCommandCheckHealth({SonarrCommandCheckHealth body = const SonarrCommandCheckHealth(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Check Health" command.

triggerCommandCleanUpRecycleBin({SonarrCommandCleanUpRecycleBin body = const SonarrCommandCleanUpRecycleBin(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Clean Up Recycle Bin" command.

triggerCommandClearBlocklist({SonarrCommandClearBlocklist body = const SonarrCommandClearBlocklist(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Clear Blocklist" command.

triggerCommandClearLog({SonarrCommandClearLog body = const SonarrCommandClearLog(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Clear Log" command.

triggerCommandCutoffUnmetEpisodeSearch({SonarrCommandCutoffUnmetEpisodeSearch body = const SonarrCommandCutoffUnmetEpisodeSearch(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Cutoff Unmet Episode Search" command.

triggerCommandDeleteLogFiles({SonarrCommandDeleteLogFiles body = const SonarrCommandDeleteLogFiles(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Delete Log Files" command.

triggerCommandDeleteUpdateLogFiles({SonarrCommandDeleteUpdateLogFiles body = const SonarrCommandDeleteUpdateLogFiles(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Delete Update Log Files" command.

triggerCommandEpisodeSearch(SonarrCommandEpisodeSearch body, {CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Episode Search" command.

triggerCommandHousekeeping({SonarrCommandHousekeeping body = const SonarrCommandHousekeeping(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Housekeeping" command.

triggerCommandImportListSync({SonarrCommandImportListSync body = const SonarrCommandImportListSync(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Import List Sync" command.

triggerCommandManualImport(SonarrCommandManualImport body, {CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Manual Import" command.

triggerCommandMessagingCleanup({SonarrCommandMessagingCleanup body = const SonarrCommandMessagingCleanup(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Messaging Cleanup" command.

triggerCommandMissingEpisodeSearch({SonarrCommandMissingEpisodeSearch body = const SonarrCommandMissingEpisodeSearch(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Missing Episode Search" command.

triggerCommandMoveSeries(SonarrCommandMoveSeries body, {CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Move Series" command.

triggerCommandProcessMonitoredDownloads({SonarrCommandProcessMonitoredDownloads body = const SonarrCommandProcessMonitoredDownloads(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Process Monitored Downloads" command.

triggerCommandRefreshMonitoredDownloads({SonarrCommandRefreshMonitoredDownloads body = const SonarrCommandRefreshMonitoredDownloads(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Refresh Monitored Downloads" command.

triggerCommandRefreshSeries({SonarrCommandRefreshSeries body = const SonarrCommandRefreshSeries(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Refresh Series" command.

triggerCommandRenameFiles(SonarrCommandRenameFiles body, {CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Rename Files" command.

triggerCommandRenameSeries(SonarrCommandRenameSeries body, {CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Rename Series" command.

triggerCommandRescanSeries({SonarrCommandRescanSeries body = const SonarrCommandRescanSeries(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Rescan Series" command.

triggerCommandResetApiKey({SonarrCommandResetApiKey body = const SonarrCommandResetApiKey(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Reset API Key" command.

triggerCommandResetQualityDefinitions({SonarrCommandResetQualityDefinitions body = const SonarrCommandResetQualityDefinitions(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Reset Quality Definitions" command.

triggerCommandRssSync({SonarrCommandRssSync body = const SonarrCommandRssSync(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "RSS Sync" command.

triggerCommandSeasonSearch(SonarrCommandSeasonSearch body, {CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Season Search" command.

triggerCommandSeriesSearch(SonarrCommandSeriesSearch body, {CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Series Search" command.

triggerCommandUpdateSceneMapping({SonarrCommandUpdateSceneMapping body = const SonarrCommandUpdateSceneMapping(), CancelToken? cancelToken}) → Future<SonarrCommand>

Trigger the "Update Scene Mapping" command.

triggerDownloadClientAction(String action, SonarrDownloadClient client, {CancelToken? cancelToken}) → Future<void>

Trigger a download client action by action name.

triggerImportListAction(String action, SonarrImportList list, {CancelToken? cancelToken}) → Future<void>

Trigger a import list action by action name.

triggerIndexerAction(String action, SonarrIndexer indexer, {CancelToken? cancelToken}) → Future<void>

Trigger a indexer action by action name.

triggerNotificationAgentAction(String action, SonarrNotification notification, {CancelToken? cancelToken}) → Future<void>

Trigger a notification agent action by action name.

triggerSeriesImport(List<SonarrSeries> series, {CancelToken? cancelToken}) → Future<List<SonarrSeries>>

Trigger a series import.

updateCustomFilter(int id, SonarrCustomFilter filter, {CancelToken? cancelToken}) → Future<SonarrCustomFilter>

Update a custom filter.

updateCustomFormat(int id, SonarrCustomFormat format, {CancelToken? cancelToken}) → Future<SonarrCustomFormat>

Update a custom format.

updateDelayProfile(int id, SonarrDelayProfile profile, {CancelToken? cancelToken}) → Future<SonarrDelayProfile>

Update a delay profile.

updateDownloadClient(int id, SonarrDownloadClient client, {CancelToken? cancelToken}) → Future<SonarrDownloadClient>

Update an existing download client.

updateDownloadClientConfig(SonarrDownloadClientConfig config, {CancelToken? cancelToken}) → Future<SonarrDownloadClientConfig>

Update the download client configuration.

updateEpisode(int id, SonarrEpisode episode, {CancelToken? cancelToken}) → Future<SonarrEpisode>

Update an existing episode.

updateEpisodeFile(int id, SonarrEpisodeFile file, {CancelToken? cancelToken}) → Future<SonarrEpisodeFile>

Update an episode file.

updateEpisodeFiles(List<SonarrEpisodeFile> files, {CancelToken? cancelToken}) → Future<List<SonarrEpisodeFile>>

Update a group of episode files.

updateEpisodes(SonarrEpisodeUpdateOptions options, {CancelToken? cancelToken}) → Future<List<SonarrEpisode>>

Bulk update a group of episodes

updateHostConfig(SonarrHostConfig config, {CancelToken? cancelToken}) → Future<SonarrHostConfig>

Update the host configuration.

updateImportList(int id, SonarrImportList list, {CancelToken? cancelToken}) → Future<SonarrImportList>

Update an existing import list.

updateImportListExclusion(int id, SonarrImportListExclusion exclusion, {CancelToken? cancelToken}) → Future<SonarrImportListExclusion>

Update an existing import list exclusion.

updateIndexer(int id, SonarrIndexer indexer, {CancelToken? cancelToken}) → Future<SonarrIndexer>

Update an existing indexer.

updateIndexerConfig(SonarrIndexerConfig config, {CancelToken? cancelToken}) → Future<SonarrIndexerConfig>

Update the indexer configuration.

updateLanguageProfile(int id, SonarrLanguageProfile profile, {CancelToken? cancelToken}) → Future<SonarrLanguageProfile>

Update an existing language profile.

updateMediaManagementConfig(SonarrMediaManagementConfig config, {CancelToken? cancelToken}) → Future<SonarrMediaManagementConfig>

Update the media management configuration.

updateMetadataAgent(int id, SonarrMetadataAgent metadata, {CancelToken? cancelToken}) → Future<SonarrMetadataAgent>

Update an existing metadata agent.

updateNamingConfig(SonarrNamingConfig config, {CancelToken? cancelToken}) → Future<SonarrNamingConfig>

Update the naming configuration.

updateNotificationAgent(int id, SonarrNotification notification, {CancelToken? cancelToken}) → Future<SonarrNotification>

Update an existing notification agent.

updateQualityDefinition(int id, SonarrQualityDefinition definition, {CancelToken? cancelToken}) → Future<SonarrQualityDefinition>

Update an existing quality definition.

updateQualityDefinitions(List<SonarrQualityDefinition> definitions, {CancelToken? cancelToken}) → Future<SonarrQualityDefinition>

Bulk update a list of existing quality definitions.

updateQualityProfile(int id, SonarrQualityProfile profile, {CancelToken? cancelToken}) → Future<SonarrQualityProfile>

Update an existing quality profile.

updateReleaseProfile(int id, SonarrReleaseProfile profile, {CancelToken? cancelToken}) → Future<SonarrReleaseProfile>

Update a release profile.

updateRemotePathMapping(int id, SonarrRemotePathMapping mapping, {CancelToken? cancelToken}) → Future<SonarrRemotePathMapping>

Update a remote path mapping.

updateSeries(int id, SonarrSeries series, {CancelToken? cancelToken}) → Future<SonarrSeries>

Update an existing series.

updateTag(int id, SonarrTag tag, {CancelToken? cancelToken}) → Future<SonarrTag>

Update a tag.

updateUiConfig(SonarrUiConfig config, {CancelToken? cancelToken}) → Future<SonarrUiConfig>

Update the UI configuration.

Operators

operator ==(Object other) → bool

The equality operator.

inherited