diff options
Diffstat (limited to 'MediaBrowser.Controller/IServerApplicationHost.cs')
| -rw-r--r-- | MediaBrowser.Controller/IServerApplicationHost.cs | 39 |
1 files changed, 19 insertions, 20 deletions
diff --git a/MediaBrowser.Controller/IServerApplicationHost.cs b/MediaBrowser.Controller/IServerApplicationHost.cs index 04ba0fabc..8537e4180 100644 --- a/MediaBrowser.Controller/IServerApplicationHost.cs +++ b/MediaBrowser.Controller/IServerApplicationHost.cs @@ -39,10 +39,9 @@ namespace MediaBrowser.Controller int HttpsPort { get; } /// <summary> - /// Gets a value indicating whether [supports HTTPS]. + /// Gets a value indicating whether the server should listen on an HTTPS port. /// </summary> - /// <value><c>true</c> if [supports HTTPS]; otherwise, <c>false</c>.</value> - bool EnableHttps { get; } + bool ListenWithHttps { get; } /// <summary> /// Gets a value indicating whether this instance has update available. @@ -57,34 +56,34 @@ namespace MediaBrowser.Controller string FriendlyName { get; } /// <summary> - /// Gets the local ip address. + /// Gets all the local IP addresses of this API instance. Each address is validated by sending a 'ping' request + /// to the API that should exist at the address. /// </summary> - /// <value>The local ip address.</value> + /// <param name="cancellationToken">A cancellation token that can be used to cancel the task.</param> + /// <returns>A list containing all the local IP addresses of the server.</returns> Task<List<IPAddress>> GetLocalIpAddresses(CancellationToken cancellationToken); /// <summary> - /// Gets the local API URL. + /// Gets a local (LAN) URL that can be used to access the API. The hostname used is the first valid configured + /// IP address that can be found via <see cref="GetLocalIpAddresses"/>. /// </summary> - /// <param name="cancellationToken">Token to cancel the request if needed.</param> - /// <param name="forceHttp">Whether to force usage of plain HTTP protocol.</param> - /// <value>The local API URL.</value> - Task<string> GetLocalApiUrl(CancellationToken cancellationToken, bool forceHttp = false); + /// <param name="cancellationToken">A cancellation token that can be used to cancel the task.</param> + /// <returns>The server URL.</returns> + Task<string> GetLocalApiUrl(CancellationToken cancellationToken); /// <summary> - /// Gets the local API URL. + /// Gets a local (LAN) URL that can be used to access the API. /// </summary> - /// <param name="hostname">The hostname.</param> - /// <param name="forceHttp">Whether to force usage of plain HTTP protocol.</param> - /// <returns>The local API URL.</returns> - string GetLocalApiUrl(ReadOnlySpan<char> hostname, bool forceHttp = false); + /// <param name="hostname">The hostname to use in the URL.</param> + /// <returns>The API URL.</returns> + string GetLocalApiUrl(ReadOnlySpan<char> hostname); /// <summary> - /// Gets the local API URL. + /// Gets a local (LAN) URL that can be used to access the API. /// </summary> - /// <param name="address">The IP address.</param> - /// <param name="forceHttp">Whether to force usage of plain HTTP protocol.</param> - /// <returns>The local API URL.</returns> - string GetLocalApiUrl(IPAddress address, bool forceHttp = false); + /// <param name="address">The IP address to use as the hostname in the URL.</param> + /// <returns>The API URL.</returns> + string GetLocalApiUrl(IPAddress address); /// <summary> /// Open a URL in an external browser window. |