aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Common/Plugins/IPlugin.cs
diff options
context:
space:
mode:
Diffstat (limited to 'MediaBrowser.Common/Plugins/IPlugin.cs')
-rw-r--r--MediaBrowser.Common/Plugins/IPlugin.cs83
1 files changed, 83 insertions, 0 deletions
diff --git a/MediaBrowser.Common/Plugins/IPlugin.cs b/MediaBrowser.Common/Plugins/IPlugin.cs
new file mode 100644
index 000000000..bffd21143
--- /dev/null
+++ b/MediaBrowser.Common/Plugins/IPlugin.cs
@@ -0,0 +1,83 @@
+using MediaBrowser.Model.Plugins;
+using System;
+
+namespace MediaBrowser.Common.Plugins
+{
+ /// <summary>
+ /// Interface IPlugin
+ /// </summary>
+ public interface IPlugin
+ {
+ /// <summary>
+ /// Gets the name of the plugin
+ /// </summary>
+ /// <value>The name.</value>
+ string Name { get; }
+
+ /// <summary>
+ /// Gets the description.
+ /// </summary>
+ /// <value>The description.</value>
+ string Description { get; }
+
+ /// <summary>
+ /// Gets the unique id.
+ /// </summary>
+ /// <value>The unique id.</value>
+ Guid Id { get; }
+
+ /// <summary>
+ /// Gets the plugin version
+ /// </summary>
+ /// <value>The version.</value>
+ Version Version { get; }
+
+ /// <summary>
+ /// Gets the path to the assembly file
+ /// </summary>
+ /// <value>The assembly file path.</value>
+ string AssemblyFilePath { get; }
+
+ /// <summary>
+ /// Gets the full path to the data folder, where the plugin can store any miscellaneous files needed
+ /// </summary>
+ /// <value>The data folder path.</value>
+ string DataFolderPath { get; }
+
+ /// <summary>
+ /// Gets the plugin info.
+ /// </summary>
+ /// <returns>PluginInfo.</returns>
+ PluginInfo GetPluginInfo();
+
+ /// <summary>
+ /// Called when just before the plugin is uninstalled from the server.
+ /// </summary>
+ void OnUninstalling();
+ }
+
+ public interface IHasPluginConfiguration
+ {
+ /// <summary>
+ /// Gets the type of configuration this plugin uses
+ /// </summary>
+ /// <value>The type of the configuration.</value>
+ Type ConfigurationType { get; }
+
+ /// <summary>
+ /// Completely overwrites the current configuration with a new copy
+ /// Returns true or false indicating success or failure
+ /// </summary>
+ /// <param name="configuration">The configuration.</param>
+ /// <exception cref="System.ArgumentNullException">configuration</exception>
+ void UpdateConfiguration(BasePluginConfiguration configuration);
+
+ /// <summary>
+ /// Gets the plugin's configuration
+ /// </summary>
+ /// <value>The configuration.</value>
+ BasePluginConfiguration Configuration { get; }
+
+ void SetStartupInfo(Action<string> directoryCreateFn);
+ }
+} \ No newline at end of file