jellyfin/MediaBrowser.Common/Configuration/IApplicationPaths.cs

89 lines
2.8 KiB
C#
Raw Normal View History

2018-12-27 23:27:57 +00:00
namespace MediaBrowser.Common.Configuration
{
/// <summary>
/// Interface IApplicationPaths.
2018-12-27 23:27:57 +00:00
/// </summary>
public interface IApplicationPaths
{
/// <summary>
/// Gets the path to the program data folder.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The program data path.</value>
string ProgramDataPath { get; }
/// <summary>
/// Gets the path to the web UI resources folder.
/// </summary>
/// <remarks>
/// This value is not relevant if the server is configured to not host any static web content.
/// </remarks>
string WebPath { get; }
2018-12-27 23:27:57 +00:00
/// <summary>
/// Gets the path to the program system folder.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The program data path.</value>
string ProgramSystemPath { get; }
/// <summary>
/// Gets the folder path to the data directory.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The data directory.</value>
string DataPath { get; }
/// <summary>
/// Gets the image cache path.
/// </summary>
/// <value>The image cache path.</value>
string ImageCachePath { get; }
/// <summary>
/// Gets the path to the plugin directory.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The plugins path.</value>
string PluginsPath { get; }
/// <summary>
/// Gets the path to the plugin configurations directory.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The plugin configurations path.</value>
string PluginConfigurationsPath { get; }
/// <summary>
/// Gets the path to the log directory.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The log directory path.</value>
string LogDirectoryPath { get; }
/// <summary>
/// Gets the path to the application configuration root directory.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The configuration directory path.</value>
string ConfigurationDirectoryPath { get; }
/// <summary>
/// Gets the path to the system configuration file.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The system configuration file path.</value>
string SystemConfigurationFilePath { get; }
/// <summary>
/// Gets the folder path to the cache directory.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The cache directory.</value>
string CachePath { get; }
/// <summary>
/// Gets the folder path to the temp directory within the cache folder.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The temp directory.</value>
string TempDirectory { get; }
/// <summary>
/// Gets the magic string used for virtual path manipulation.
/// </summary>
/// <value>The magic string used for virtual path manipulation.</value>
2018-12-27 23:27:57 +00:00
string VirtualDataPath { get; }
}
}