Post-PR improvements

This commit is contained in:
Archi
2023-04-20 22:24:38 +02:00
parent 97da56d016
commit 55b8c8f0d4
2 changed files with 65 additions and 50 deletions

View File

@@ -25,8 +25,14 @@ namespace ArchiSteamFarm.Plugins.Interfaces;
#if !NETFRAMEWORK && !NETSTANDARD
public interface IWebInterface : IPlugin {
/// <summary>
/// Specifies physical path to static WWW files provided by the plugin. Can be either relative to plugin's assembly location, or absolute. Default "www" value assumes that you ship "www" directory together with your plugin's main DLL assembly, similar to ASF.
/// </summary>
string PhysicalPath => "www";
/// <summary>
/// Specifies web path (address) under which ASF should host your static WWW files in <see cref="PhysicalPath" /> directory. Default "/" value allows you to override default ASF files and gives you full flexibility in your www directory. However, you can instead host your files under some fixed location specified here, such as "/MyPlugin".
/// </summary>
[JsonProperty]
string WebPath => "/";
}