aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Model/Plugins/PluginStatus.cs
diff options
context:
space:
mode:
Diffstat (limited to 'MediaBrowser.Model/Plugins/PluginStatus.cs')
-rw-r--r--MediaBrowser.Model/Plugins/PluginStatus.cs33
1 files changed, 31 insertions, 2 deletions
diff --git a/MediaBrowser.Model/Plugins/PluginStatus.cs b/MediaBrowser.Model/Plugins/PluginStatus.cs
index a953206e8..2acc56811 100644
--- a/MediaBrowser.Model/Plugins/PluginStatus.cs
+++ b/MediaBrowser.Model/Plugins/PluginStatus.cs
@@ -1,5 +1,3 @@
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
-#pragma warning disable SA1602 // Enumeration items should be documented
namespace MediaBrowser.Model.Plugins
{
/// <summary>
@@ -7,12 +5,43 @@ namespace MediaBrowser.Model.Plugins
/// </summary>
public enum PluginStatus
{
+ /// <summary>
+ /// This plugin requires a restart in order for it to load. This is a memory only status.
+ /// The actual status of the plugin after reload is present in the manifest.
+ /// eg. A disabled plugin will still be active until the next restart, and so will have a memory status of RestartRequired,
+ /// but a disk manifest status of Disabled.
+ /// </summary>
RestartRequired = 1,
+
+ /// <summary>
+ /// This plugin is currently running.
+ /// </summary>
Active = 0,
+
+ /// <summary>
+ /// This plugin has been marked as disabled.
+ /// </summary>
Disabled = -1,
+
+ /// <summary>
+ /// This plugin does not meet the TargetAbi / MaxAbi requirements.
+ /// </summary>
NotSupported = -2,
+
+ /// <summary>
+ /// This plugin caused an error when instantiated. (Either DI loop, or exception)
+ /// </summary>
Malfunction = -3,
+
+ /// <summary>
+ /// This plugin has been superceded by another version.
+ /// </summary>
Superceded = -4,
+
+ /// <summary>
+ /// An attempt to remove this plugin from disk will happen at every restart.
+ /// It will not be loaded, if unable to do so.
+ /// </summary>
DeleteOnStartup = -5
}
}