diff options
Diffstat (limited to 'MediaBrowser.Common/Plugins/IHasPluginConfiguration.cs')
| -rw-r--r-- | MediaBrowser.Common/Plugins/IHasPluginConfiguration.cs | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/MediaBrowser.Common/Plugins/IHasPluginConfiguration.cs b/MediaBrowser.Common/Plugins/IHasPluginConfiguration.cs new file mode 100644 index 000000000..42ad85dd3 --- /dev/null +++ b/MediaBrowser.Common/Plugins/IHasPluginConfiguration.cs @@ -0,0 +1,33 @@ +using System; +using MediaBrowser.Model.Plugins; + +namespace MediaBrowser.Common.Plugins +{ + /// <summary> + /// Defines the <see cref="IHasPluginConfiguration" />. + /// </summary> + public interface IHasPluginConfiguration + { + /// <summary> + /// Gets the type of configuration this plugin uses. + /// </summary> + Type ConfigurationType { get; } + + /// <summary> + /// Gets the plugin's configuration. + /// </summary> + BasePluginConfiguration Configuration { get; } + + /// <summary> + /// Completely overwrites the current configuration with a new copy. + /// </summary> + /// <param name="configuration">The configuration.</param> + void UpdateConfiguration(BasePluginConfiguration configuration); + + /// <summary> + /// Sets the startup directory creation function. + /// </summary> + /// <param name="directoryCreateFn">The directory function used to create the configuration folder.</param> + void SetStartupInfo(Action<string> directoryCreateFn); + } +} |
