You are here: Plugin API > Library Reference > IPlugin Interface
IPlugin Interface
The IPlugin interface represents the plugin. For the plugin assembly to be considered valid, it must implement the IPlugin interface.
Properties
- bool IsActivated – Gets a value indicating whether the plugin is activated or not.
Methods
- void Execute() – Activates the plugin. This method is called when users click “Enable” in the Plugins dialog.
- string GetAuthor() – Returns the author of the plugin.
- string GetDescription() – Returns the description of the plugin.
- string GetName() – Returns the name of the plugin.
- string GetVersion() – Returns the version of the plugin.
- void Initialize(IHost) – Initializes the plugin. An instance of IHost is passed in as a parameter, which gives users access to Flare/Contributor components.
- void Stop() – Deactivates the plugin. This method is called when users click “Disable” in the Plugins dialog.