IHasPluginConfiguration.cs 1.1 KB

123456789101112131415161718192021222324252627282930313233
  1. using System;
  2. using MediaBrowser.Model.Plugins;
  3. namespace MediaBrowser.Common.Plugins
  4. {
  5. /// <summary>
  6. /// Defines the <see cref="IHasPluginConfiguration" />.
  7. /// </summary>
  8. public interface IHasPluginConfiguration
  9. {
  10. /// <summary>
  11. /// Gets the type of configuration this plugin uses.
  12. /// </summary>
  13. Type ConfigurationType { get; }
  14. /// <summary>
  15. /// Gets the plugin's configuration.
  16. /// </summary>
  17. BasePluginConfiguration Configuration { get; }
  18. /// <summary>
  19. /// Completely overwrites the current configuration with a new copy.
  20. /// </summary>
  21. /// <param name="configuration">The configuration.</param>
  22. void UpdateConfiguration(BasePluginConfiguration configuration);
  23. /// <summary>
  24. /// Sets the startup directory creation function.
  25. /// </summary>
  26. /// <param name="directoryCreateFn">The directory function used to create the configuration folder.</param>
  27. void SetStartupInfo(Action<string> directoryCreateFn);
  28. }
  29. }