aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Common/Updates/IInstallationManager.cs
diff options
context:
space:
mode:
authorGreenback <jimcartlidge@yahoo.co.uk>2020-12-06 23:48:54 +0000
committerGreenback <jimcartlidge@yahoo.co.uk>2020-12-14 16:14:39 +0000
commit7986465cf785ca385fd1765326887e550bced033 (patch)
tree8859e9b336326081b9dfdc8d550d7f7d6d6652b7 /MediaBrowser.Common/Updates/IInstallationManager.cs
parentf2c2beca0f9a249edd7cc967c328d32ebdc30092 (diff)
Initial upload
Diffstat (limited to 'MediaBrowser.Common/Updates/IInstallationManager.cs')
-rw-r--r--MediaBrowser.Common/Updates/IInstallationManager.cs32
1 files changed, 20 insertions, 12 deletions
diff --git a/MediaBrowser.Common/Updates/IInstallationManager.cs b/MediaBrowser.Common/Updates/IInstallationManager.cs
index 585b1ee19..dd9e0cc3f 100644
--- a/MediaBrowser.Common/Updates/IInstallationManager.cs
+++ b/MediaBrowser.Common/Updates/IInstallationManager.cs
@@ -1,4 +1,4 @@
-#pragma warning disable CS1591
+#nullable enable
using System;
using System.Collections.Generic;
@@ -9,6 +9,9 @@ using MediaBrowser.Model.Updates;
namespace MediaBrowser.Common.Updates
{
+ /// <summary>
+ /// Defines the <see cref="IInstallationManager" />.
+ /// </summary>
public interface IInstallationManager : IDisposable
{
/// <summary>
@@ -21,12 +24,13 @@ namespace MediaBrowser.Common.Updates
/// </summary>
/// <param name="manifestName">Name of the repository.</param>
/// <param name="manifest">The URL to query.</param>
+ /// <param name="filterIncompatible">Filter out incompatible plugins.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{IReadOnlyList{PackageInfo}}.</returns>
- Task<IList<PackageInfo>> GetPackages(string manifestName, string manifest, CancellationToken cancellationToken = default);
+ Task<IList<PackageInfo>> GetPackages(string manifestName, string manifest, bool filterIncompatible, CancellationToken cancellationToken = default);
/// <summary>
- /// Gets all available packages.
+ /// Gets all available packages that are supported by this version.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{IReadOnlyList{PackageInfo}}.</returns>
@@ -42,9 +46,11 @@ namespace MediaBrowser.Common.Updates
/// <returns>All plugins matching the requirements.</returns>
IEnumerable<PackageInfo> FilterPackages(
IEnumerable<PackageInfo> availablePackages,
- string name = null,
- Guid guid = default,
- Version specificVersion = null);
+ string? name = null,
+#pragma warning disable CA1720 // Identifier contains type name
+ Guid? guid = default,
+#pragma warning restore CA1720 // Identifier contains type name
+ Version? specificVersion = null);
/// <summary>
/// Returns all compatible versions ordered from newest to oldest.
@@ -57,13 +63,15 @@ namespace MediaBrowser.Common.Updates
/// <returns>All compatible versions ordered from newest to oldest.</returns>
IEnumerable<InstallationInfo> GetCompatibleVersions(
IEnumerable<PackageInfo> availablePackages,
- string name = null,
- Guid guid = default,
- Version minVersion = null,
- Version specificVersion = null);
+ string? name = null,
+#pragma warning disable CA1720 // Identifier contains type name
+ Guid? guid = default,
+#pragma warning restore CA1720 // Identifier contains type name
+ Version? minVersion = null,
+ Version? specificVersion = null);
/// <summary>
- /// Returns the available plugin updates.
+ /// Returns the available compatible plugin updates.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The available plugin updates.</returns>
@@ -81,7 +89,7 @@ namespace MediaBrowser.Common.Updates
/// Uninstalls a plugin.
/// </summary>
/// <param name="plugin">The plugin.</param>
- void UninstallPlugin(IPlugin plugin);
+ void UninstallPlugin(LocalPlugin plugin);
/// <summary>
/// Cancels the installation.