Interface IServerApplicationHost

Interface IServerApplicationHost

Inherited Members
Namespace: MediaBrowser.Controller
Assembly: MediaBrowser.Controller.dll
Syntax
public interface IServerApplicationHost : IApplicationHost

Properties

AvailablePackage

Declaration
PackageVersionInfo AvailablePackage { get; }
Property Value
Type Description
PackageVersionInfo

AvailableVersion

Declaration
Version AvailableVersion { get; }
Property Value
Type Description
System.Version

CanLaunchWebBrowser

Declaration
bool CanLaunchWebBrowser { get; }
Property Value
Type Description
System.Boolean

CodecProviders

Gets the codec providers.

Declaration
ICodecProvider[] CodecProviders { get; }
Property Value
Type Description
ICodecProvider[]

The codec providers.

EnableHttps

Gets a value indicating whether [supports HTTPS].

Declaration
bool EnableHttps { get; }
Property Value
Type Description
System.Boolean

true if [supports HTTPS]; otherwise, false.

FriendlyName

Gets the name of the friendly.

Declaration
string FriendlyName { get; }
Property Value
Type Description
System.String

The name of the friendly.

HardwareAccelerationRequiresPremiere

Declaration
bool HardwareAccelerationRequiresPremiere { get; }
Property Value
Type Description
System.Boolean

HasUpdateAvailable

Gets a value indicating whether this instance has update available.

Declaration
bool HasUpdateAvailable { get; }
Property Value
Type Description
System.Boolean

true if this instance has update available; otherwise, false.

HttpPort

Gets the HTTP server port.

Declaration
int HttpPort { get; }
Property Value
Type Description
System.Int32

The HTTP server port.

HttpsPort

Gets the HTTPS port.

Declaration
int HttpsPort { get; }
Property Value
Type Description
System.Int32

The HTTPS port.

PluginConfigurationPages

Gets or sets the plugin configuration pages.

Declaration
IPluginConfigurationPage[] PluginConfigurationPages { get; }
Property Value
Type Description
IPluginConfigurationPage[]

The plugin configuration pages.

SupportsAutoRunAtStartup

Gets a value indicating whether [supports automatic run at startup].

Declaration
bool SupportsAutoRunAtStartup { get; }
Property Value
Type Description
System.Boolean

true if [supports automatic run at startup]; otherwise, false.

Methods

BackupDatabases(String)

Declaration
void BackupDatabases(string destinationFolder)
Parameters
Type Name Description
System.String destinationFolder

ExpandVirtualPath(String)

Declaration
string ExpandVirtualPath(string path)
Parameters
Type Name Description
System.String path
Returns
Type Description
System.String

ExpandVirtualPathJson(String)

Declaration
string ExpandVirtualPathJson(string path)
Parameters
Type Name Description
System.String path
Returns
Type Description
System.String

GetLocalApiUrl(IPAddress)

Gets the local API URL.

Declaration
string GetLocalApiUrl(IPAddress address)
Parameters
Type Name Description
System.Net.IPAddress address
Returns
Type Description
System.String

GetLocalApiUrl(String)

Gets the local API URL.

Declaration
string GetLocalApiUrl(string host)
Parameters
Type Name Description
System.String host

The host.
Returns
Type Description
System.String

System.String.

GetLocalApiUrl(CancellationToken)

Gets the local API URL.

Declaration
Task<string> GetLocalApiUrl(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.String>

The local API URL.

GetLocalIpAddresses(AddressFamily, CancellationToken)

Declaration
Task<List<IPAddress>> GetLocalIpAddresses(AddressFamily family, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Net.Sockets.AddressFamily family
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.Net.IPAddress>>

GetLocalIpAddresses(CancellationToken)

Gets the local ip address.

Declaration
Task<List<IPAddress>> GetLocalIpAddresses(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.Net.IPAddress>>

The local ip address.

GetLocalIpAddressForRemoteAddress(IPAddress, CancellationToken)

Declaration
Task<IPAddress> GetLocalIpAddressForRemoteAddress(IPAddress address, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Net.IPAddress address
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Net.IPAddress>

GetPublicSystemInfo(IPAddress, AuthorizationInfo, CancellationToken)

Declaration
Task<PublicSystemInfo> GetPublicSystemInfo(IPAddress remoteAddress, AuthorizationInfo authorizationInfo, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Net.IPAddress remoteAddress
AuthorizationInfo authorizationInfo
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<PublicSystemInfo>

GetPublicSystemInfo(CancellationToken)

Declaration
Task<PublicSystemInfo> GetPublicSystemInfo(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<PublicSystemInfo>

GetReleaseNotes(String, CancellationToken)

Declaration
Task<PackageVersionInfo> GetReleaseNotes(string version, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String version
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<PackageVersionInfo>

GetReleaseNotesVersions(CancellationToken)

Declaration
Task<PackageVersionInfo[]> GetReleaseNotesVersions(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<PackageVersionInfo[]>

GetSystemInfo(IPAddress, AuthorizationInfo, CancellationToken)

Declaration
Task<SystemInfo> GetSystemInfo(IPAddress remoteAddress, AuthorizationInfo authorizationInfo, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Net.IPAddress remoteAddress
AuthorizationInfo authorizationInfo
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<SystemInfo>

GetSystemInfo(IPAddress, CancellationToken)

Gets the system info.

Declaration
Task<SystemInfo> GetSystemInfo(IPAddress remoteAddress, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Net.IPAddress remoteAddress
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<SystemInfo>

SystemInfo.

GetWakeOnLanInfo()

Declaration
WakeOnLanInfo[] GetWakeOnLanInfo()
Returns
Type Description
WakeOnLanInfo[]

LaunchUrl(String)

Declaration
void LaunchUrl(string url)
Parameters
Type Name Description
System.String url

ReverseVirtualPath(String)

Declaration
string ReverseVirtualPath(string path)
Parameters
Type Name Description
System.String path
Returns
Type Description
System.String

ReverseVirtualPathJson(String)

Declaration
string ReverseVirtualPathJson(string path)
Parameters
Type Name Description
System.String path
Returns
Type Description
System.String

Events

Disposed

Declaration
event EventHandler Disposed
Event Type
Type Description
System.EventHandler

EnterMaintenanceMode

Declaration
event EventHandler EnterMaintenanceMode
Event Type
Type Description
System.EventHandler

ExitMaintenanceMode

Declaration
event EventHandler ExitMaintenanceMode
Event Type
Type Description
System.EventHandler

HasUpdateAvailableChanged

Declaration
event EventHandler HasUpdateAvailableChanged
Event Type
Type Description
System.EventHandler

Extension Methods