Hermod.PluginFramework.IPlugin Interface Reference

Basic contract between Hermod and any plugins. More...

Inheritance diagram for Hermod.PluginFramework.IPlugin:

Public Member Functions
void	OnLoad (IPluginDelegator pluginDelegator)
	Method that is called once the plugin has been loaded. This may be used for pre-init purposes.
void	OnStart ()
	Method that is called once Hermod has completed its startup procedures and is ready to run.
void	OnStop ()
	Method that is called when Hermod is shutting down.
void	OnConfigChanged (ConfigChangedEventArgs e)
	Method that is called when an application-wide configuration has been modified.
void	OnConfigLoaded ()
	Method that is called when the application-wide configurations have been loaded.

Properties
Version	PluginVersion [get]
	Gets the version of the plugin.
string	PluginName [get]
	Gets the name of the plugin.
List< ICommand >	PluginCommands [get]
	A list of all commands this plugin provides.

Detailed Description

Basic contract between Hermod and any plugins.

Definition at line 14 of file IPlugin.cs.

Member Function Documentation

OnConfigChanged()

void Hermod.PluginFramework.IPlugin.OnConfigChanged

(

ConfigChangedEventArgs

e

)

Method that is called when an application-wide configuration has been modified.

Parameters

e	The ConfigChangedEventArgs that are generated when a config was modified.

Implemented in Hermod.EmailImport.EmailImporter, and Hermod.PluginFramework.Plugin.

OnConfigLoaded()

void Hermod.PluginFramework.IPlugin.OnConfigLoaded

(

)

Method that is called when the application-wide configurations have been loaded.

Implemented in Hermod.EmailImport.EmailImporter, and Hermod.PluginFramework.Plugin.

OnLoad()

void Hermod.PluginFramework.IPlugin.OnLoad

(

IPluginDelegator

pluginDelegator

)

Method that is called once the plugin has been loaded. This may be used for pre-init purposes.

Parameters

pluginDelegator

The delegator allocated to this plugin.

Implemented in Hermod.EmailImport.EmailImporter, and Hermod.PluginFramework.Plugin.

OnStart()

void Hermod.PluginFramework.IPlugin.OnStart

(

)

Method that is called once Hermod has completed its startup procedures and is ready to run.

Implemented in Hermod.EmailImport.EmailImporter, and Hermod.PluginFramework.Plugin.

Referenced by Hermod.Hermod.HandleLoadPlugin().

OnStop()

void Hermod.PluginFramework.IPlugin.OnStop

(

)

Method that is called when Hermod is shutting down.

Implemented in Hermod.EmailImport.EmailImporter, and Hermod.PluginFramework.Plugin.

Property Documentation

PluginCommands

List<ICommand> Hermod.PluginFramework.IPlugin.PluginCommands

get

A list of all commands this plugin provides.

Implemented in Hermod.PluginFramework.Plugin.

Definition at line 29 of file IPlugin.cs.

{ get; }

PluginName

string Hermod.PluginFramework.IPlugin.PluginName

get

Gets the name of the plugin.

Implemented in Hermod.PluginFramework.Plugin.

Definition at line 24 of file IPlugin.cs.

{ get; }

PluginVersion

Version Hermod.PluginFramework.IPlugin.PluginVersion

get

Gets the version of the plugin.

Implemented in Hermod.PluginFramework.Plugin.

Definition at line 19 of file IPlugin.cs.

{ get; }

---

The documentation for this interface was generated from the following file:

• IPlugin.cs