IInstallationManager.cs 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. #pragma warning disable CS1591
  2. using System;
  3. using System.Collections.Generic;
  4. using System.Threading;
  5. using System.Threading.Tasks;
  6. using MediaBrowser.Common.Plugins;
  7. using MediaBrowser.Model.Events;
  8. using MediaBrowser.Model.Updates;
  9. namespace MediaBrowser.Common.Updates
  10. {
  11. public interface IInstallationManager : IDisposable
  12. {
  13. event EventHandler<InstallationEventArgs> PackageInstalling;
  14. event EventHandler<InstallationEventArgs> PackageInstallationCompleted;
  15. event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed;
  16. event EventHandler<InstallationEventArgs> PackageInstallationCancelled;
  17. /// <summary>
  18. /// Occurs when a plugin is uninstalled.
  19. /// </summary>
  20. event EventHandler<GenericEventArgs<IPlugin>> PluginUninstalled;
  21. /// <summary>
  22. /// Occurs when a plugin is updated.
  23. /// </summary>
  24. event EventHandler<GenericEventArgs<(IPlugin, VersionInfo)>> PluginUpdated;
  25. /// <summary>
  26. /// Occurs when a plugin is installed.
  27. /// </summary>
  28. event EventHandler<GenericEventArgs<VersionInfo>> PluginInstalled;
  29. /// <summary>
  30. /// Gets the completed installations.
  31. /// </summary>
  32. IEnumerable<InstallationInfo> CompletedInstallations { get; }
  33. /// <summary>
  34. /// Gets all available packages.
  35. /// </summary>
  36. /// <param name="cancellationToken">The cancellation token.</param>
  37. /// <returns>Task{IReadOnlyList{PackageInfo}}.</returns>
  38. Task<IReadOnlyList<PackageInfo>> GetAvailablePackages(CancellationToken cancellationToken = default);
  39. /// <summary>
  40. /// Returns all plugins matching the requirements.
  41. /// </summary>
  42. /// <param name="availablePackages">The available packages.</param>
  43. /// <param name="name">The name of the plugin.</param>
  44. /// <param name="guid">The id of the plugin.</param>
  45. /// <returns>All plugins matching the requirements.</returns>
  46. IEnumerable<PackageInfo> FilterPackages(
  47. IEnumerable<PackageInfo> availablePackages,
  48. string name = null,
  49. Guid guid = default);
  50. /// <summary>
  51. /// Returns all compatible versions ordered from newest to oldest.
  52. /// </summary>
  53. /// <param name="availableVersions">The available version of the plugin.</param>
  54. /// <param name="minVersion">The minimum required version of the plugin.</param>
  55. /// <returns>All compatible versions ordered from newest to oldest.</returns>
  56. IEnumerable<VersionInfo> GetCompatibleVersions(
  57. IEnumerable<VersionInfo> availableVersions,
  58. Version minVersion = null);
  59. /// <summary>
  60. /// Returns all compatible versions ordered from newest to oldest.
  61. /// </summary>
  62. /// <param name="availablePackages">The available packages.</param>
  63. /// <param name="name">The name.</param>
  64. /// <param name="guid">The guid of the plugin.</param>
  65. /// <param name="minVersion">The minimum required version of the plugin.</param>
  66. /// <returns>All compatible versions ordered from newest to oldest.</returns>
  67. IEnumerable<VersionInfo> GetCompatibleVersions(
  68. IEnumerable<PackageInfo> availablePackages,
  69. string name = null,
  70. Guid guid = default,
  71. Version minVersion = null);
  72. /// <summary>
  73. /// Returns the available plugin updates.
  74. /// </summary>
  75. /// <param name="cancellationToken">The cancellation token.</param>
  76. /// <returns>The available plugin updates.</returns>
  77. Task<IEnumerable<VersionInfo>> GetAvailablePluginUpdates(CancellationToken cancellationToken = default);
  78. /// <summary>
  79. /// Installs the package.
  80. /// </summary>
  81. /// <param name="package">The package.</param>
  82. /// <param name="cancellationToken">The cancellation token.</param>
  83. /// <returns><see cref="Task" />.</returns>
  84. Task InstallPackage(VersionInfo package, CancellationToken cancellationToken = default);
  85. /// <summary>
  86. /// Uninstalls a plugin.
  87. /// </summary>
  88. /// <param name="plugin">The plugin.</param>
  89. void UninstallPlugin(IPlugin plugin);
  90. /// <summary>
  91. /// Cancels the installation.
  92. /// </summary>
  93. /// <param name="id">The id of the package that is being installed.</param>
  94. /// <returns>Returns true if the install was cancelled.</returns>
  95. bool CancelInstallation(Guid id);
  96. }
  97. }