Interface IInstallationManager

Inherited Members
System.IDisposable.Dispose()
Namespace: MediaBrowser.Common.Updates
Assembly: MediaBrowser.Common.dll
Syntax
public interface IInstallationManager : IDisposable

Properties

CompletedInstallations

The completed installations

Declaration
InstallationInfo[] CompletedInstallations { get; }
Property Value
Type Description
InstallationInfo[]

CurrentInstallations

The current installations

Declaration
List<Tuple<InstallationInfo, CancellationTokenSource>> CurrentInstallations { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Tuple<InstallationInfo, System.Threading.CancellationTokenSource>>

Methods

GetAvailablePackages(CancellationToken, Boolean, String, Version)

Gets all available packages.

Declaration
Task<List<PackageInfo>> GetAvailablePackages(CancellationToken cancellationToken, bool withRegistration = true, string packageType = null, Version applicationVersion = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token.
System.Boolean withRegistration

if set to true [with registration].
System.String packageType

Type of the package.
System.Version applicationVersion

The application version.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<PackageInfo>>

Task{List{PackageInfo}}.

GetAvailablePluginUpdates(Version, LogSeverity, CancellationToken)

Declaration
Task<PackageVersionInfo[]> GetAvailablePluginUpdates(Version applicationVersion, LogSeverity logSeverity, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Version applicationVersion
LogSeverity logSeverity
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<PackageVersionInfo[]>

GetAvailablePluginUpdates(Version, CancellationToken)

Gets the available plugin updates.

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

GetLatestCompatibleVersion(ReadOnlyMemory<Char>, ReadOnlyMemory<Char>, Version, PackageVersionClass, CancellationToken)

Gets the latest compatible version.

Declaration
Task<PackageVersionInfo> GetLatestCompatibleVersion(ReadOnlyMemory<char> name, ReadOnlyMemory<char> guid, Version currentServerVersion, PackageVersionClass classification, CancellationToken cancellationToken)
Parameters
Type Name Description
System.ReadOnlyMemory<System.Char> name

The name.
System.ReadOnlyMemory<System.Char> guid

The assembly guid
System.Version currentServerVersion

The current server version.
PackageVersionClass classification

The classification.
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<PackageVersionInfo>

Task{PackageVersionInfo}.

GetPackage(ReadOnlyMemory<Char>, ReadOnlyMemory<Char>, PackageVersionClass, Version, CancellationToken)

Gets the package.

Declaration
Task<PackageVersionInfo> GetPackage(ReadOnlyMemory<char> name, ReadOnlyMemory<char> guid, PackageVersionClass classification, Version version, CancellationToken cancellationToken)
Parameters
Type Name Description
System.ReadOnlyMemory<System.Char> name

The name.
System.ReadOnlyMemory<System.Char> guid

The assembly guid
PackageVersionClass classification

The classification.
System.Version version

The version.
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<PackageVersionInfo>

Task{PackageVersionInfo}.

InstallPackage(PackageVersionInfo, Boolean, IProgress<Double>, CancellationToken)

Installs the package.

Declaration
Task InstallPackage(PackageVersionInfo package, bool isPlugin, IProgress<double> progress, CancellationToken cancellationToken)
Parameters
Type Name Description
PackageVersionInfo package

The package.
System.Boolean isPlugin

if set to true [is plugin].
System.IProgress<System.Double> progress

The progress.
System.Threading.CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
System.Threading.Tasks.Task

Task.
Exceptions
Type Condition
System.ArgumentNullException

package

UninstallPlugin(IPlugin)

Uninstalls a plugin

Declaration
void UninstallPlugin(IPlugin plugin)
Parameters
Type Name Description
IPlugin plugin

The plugin.
Exceptions
Type Condition
System.ArgumentException

Events

PackageInstallationCancelled

Declaration
event EventHandler<InstallationEventArgs> PackageInstallationCancelled
Event Type
Type Description
System.EventHandler<InstallationEventArgs>

PackageInstallationCompleted

Declaration
event EventHandler<InstallationEventArgs> PackageInstallationCompleted
Event Type
Type Description
System.EventHandler<InstallationEventArgs>

PackageInstallationFailed

Declaration
event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed
Event Type
Type Description
System.EventHandler<InstallationFailedEventArgs>

PackageInstalling

Declaration
event EventHandler<InstallationEventArgs> PackageInstalling
Event Type
Type Description
System.EventHandler<InstallationEventArgs>

PluginInstalled

Occurs when [plugin updated].

Declaration
event EventHandler<GenericEventArgs<PackageVersionInfo>> PluginInstalled
Event Type
Type Description
System.EventHandler<GenericEventArgs<PackageVersionInfo>>

PluginUninstalled

Occurs when [plugin uninstalled].

Declaration
event EventHandler<GenericEventArgs<IPlugin>> PluginUninstalled
Event Type
Type Description
System.EventHandler<GenericEventArgs<IPlugin>>

PluginUpdated

Occurs when [plugin updated].

Declaration
event EventHandler<GenericEventArgs<Tuple<IPlugin, PackageVersionInfo>>> PluginUpdated
Event Type
Type Description
System.EventHandler<GenericEventArgs<System.Tuple<IPlugin, PackageVersionInfo>>>

Extension Methods