diff options
| author | Bond-009 <bond.009@outlook.com> | 2019-11-07 10:55:02 +0100 |
|---|---|---|
| committer | Bond-009 <bond.009@outlook.com> | 2019-11-07 10:55:02 +0100 |
| commit | 126165080b9d28521b24d1764fb343eb12153ce1 (patch) | |
| tree | 016bcb627d0ddeb1666949f7548d6c47dcb99c6b | |
| parent | 983d38a43bd617de11724196f35822f07860a2eb (diff) | |
Doc improvements
| -rw-r--r-- | Emby.Server.Implementations/Updates/InstallationManager.cs | 21 | ||||
| -rw-r--r-- | MediaBrowser.Common/Updates/IInstallationManager.cs | 11 |
2 files changed, 17 insertions, 15 deletions
diff --git a/Emby.Server.Implementations/Updates/InstallationManager.cs b/Emby.Server.Implementations/Updates/InstallationManager.cs index 8dcfb0996..1c5402268 100644 --- a/Emby.Server.Implementations/Updates/InstallationManager.cs +++ b/Emby.Server.Implementations/Updates/InstallationManager.cs @@ -50,12 +50,12 @@ namespace Emby.Server.Implementations.Updates /// <summary> /// The current installations. /// </summary> - private List<(InstallationInfo info, CancellationTokenSource token)> _currentInstallations; + private readonly List<(InstallationInfo info, CancellationTokenSource token)> _currentInstallations; /// <summary> /// The completed installations. /// </summary> - private ConcurrentBag<InstallationInfo> _completedInstallationsInternal; + private readonly ConcurrentBag<InstallationInfo> _completedInstallationsInternal; public InstallationManager( ILogger<InstallationManager> logger, @@ -85,29 +85,28 @@ namespace Emby.Server.Implementations.Updates _zipClient = zipClient; } + /// <inheritdoc /> public event EventHandler<InstallationEventArgs> PackageInstalling; + /// <inheritdoc /> public event EventHandler<InstallationEventArgs> PackageInstallationCompleted; + /// <inheritdoc /> public event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed; + /// <inheritdoc /> public event EventHandler<InstallationEventArgs> PackageInstallationCancelled; - /// <summary> - /// Occurs when a plugin is uninstalled. - /// </summary> + /// <inheritdoc /> public event EventHandler<GenericEventArgs<IPlugin>> PluginUninstalled; - /// <summary> - /// Occurs when a plugin plugin is updated. - /// </summary> + /// <inheritdoc /> public event EventHandler<GenericEventArgs<(IPlugin, PackageVersionInfo)>> PluginUpdated; - /// <summary> - /// Occurs when a plugin plugin is installed. - /// </summary> + /// <inheritdoc /> public event EventHandler<GenericEventArgs<PackageVersionInfo>> PluginInstalled; + /// <inheritdoc /> public IEnumerable<InstallationInfo> CompletedInstallations => _completedInstallationsInternal; /// <inheritdoc /> diff --git a/MediaBrowser.Common/Updates/IInstallationManager.cs b/MediaBrowser.Common/Updates/IInstallationManager.cs index ce4829c13..7850385fd 100644 --- a/MediaBrowser.Common/Updates/IInstallationManager.cs +++ b/MediaBrowser.Common/Updates/IInstallationManager.cs @@ -13,27 +13,30 @@ namespace MediaBrowser.Common.Updates public interface IInstallationManager : IDisposable { event EventHandler<InstallationEventArgs> PackageInstalling; + event EventHandler<InstallationEventArgs> PackageInstallationCompleted; + event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed; + event EventHandler<InstallationEventArgs> PackageInstallationCancelled; /// <summary> - /// Occurs when [plugin uninstalled]. + /// Occurs when a plugin is uninstalled. /// </summary> event EventHandler<GenericEventArgs<IPlugin>> PluginUninstalled; /// <summary> - /// Occurs when [plugin updated]. + /// Occurs when a plugin is updated. /// </summary> event EventHandler<GenericEventArgs<(IPlugin, PackageVersionInfo)>> PluginUpdated; /// <summary> - /// Occurs when [plugin updated]. + /// Occurs when a plugin is installed. /// </summary> event EventHandler<GenericEventArgs<PackageVersionInfo>> PluginInstalled; /// <summary> - /// The completed installations + /// Gets the completed installations /// </summary> IEnumerable<InstallationInfo> CompletedInstallations { get; } |