MediaBrowser.Controller/Plugins/IPluginConfigurationPage.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

using System.IO;
using MediaBrowser.Common.Plugins;

namespace MediaBrowser.Controller.Plugins
{
    /// <summary>
    /// Interface IConfigurationPage.
    /// </summary>
    public interface IPluginConfigurationPage
    {
        /// <summary>
        /// Gets the name.
        /// </summary>
        /// <value>The name.</value>
        string Name { get; }

        /// <summary>
        /// Gets the type of the configuration page.
        /// </summary>
        /// <value>The type of the configuration page.</value>
        ConfigurationPageType ConfigurationPageType { get; }

        /// <summary>
        /// Gets the plugin.
        /// </summary>
        /// <value>The plugin.</value>
        IPlugin Plugin { get; }

        /// <summary>
        /// Gets the HTML stream.
        /// </summary>
        /// <returns>Stream.</returns>
        Stream GetHtmlStream();
    }

    /// <summary>
    /// Enum ConfigurationPageType.
    /// </summary>
    public enum ConfigurationPageType
    {
        /// <summary>
        /// The plugin configuration.
        /// </summary>
        PluginConfiguration,

        /// <summary>
        /// The none.
        /// </summary>
        None
    }
}