Class BasePlugin

Inheritance
System.Object
BasePlugin
BasePlugin<TConfigurationType>
BasePluginSimpleUI<TOptionType>
Namespace: MediaBrowser.Common.Plugins
Assembly: MediaBrowser.Common.dll
Syntax
public abstract class BasePlugin : IPlugin, IPluginAssembly

Properties

AssemblyFilePath

Gets the path to the assembly file

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

The assembly file path.

DataFolderPath

Gets the full path to the data folder, where the plugin can store any miscellaneous files needed

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

The data folder path.

Description

Gets the description.

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

The description.

Id

Gets the unique id.

Declaration
public virtual Guid Id { get; }
Property Value
Type Description
System.Guid

The unique id.

Name

Gets the name of the plugin

Declaration
public abstract string Name { get; }
Property Value
Type Description
System.String

The name.

Version

Gets the plugin version

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

The version.

Methods

GetPluginInfo()

Gets the plugin info.

Declaration
public virtual PluginInfo GetPluginInfo()
Returns
Type Description
PluginInfo

PluginInfo.

GetPluginPageUrl(String)

Declaration
public static string GetPluginPageUrl(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.String

OnUninstalling()

Called when just before the plugin is uninstalled from the server.

Declaration
public virtual void OnUninstalling()

SetAttributes(String, String, Version)

Declaration
public void SetAttributes(string assemblyFilePath, string dataFolderPath, Version assemblyVersion)
Parameters
Type Name Description
System.String assemblyFilePath
System.String dataFolderPath
System.Version assemblyVersion

SetId(Guid)

Declaration
public void SetId(Guid assemblyId)
Parameters
Type Name Description
System.Guid assemblyId

Implements

Extension Methods