Interface IWebPlugin

Interface for a plugin to allow web based content serving on the elections Website.

Namespace: Eco.Core.Plugins.Interfaces
Assembly: Eco.Core.dll
Syntax
public interface IWebPlugin
Remarks

It is not recommended to write IWebPlugin implementations that are not compiled to a DLL assembly prior to server start.

Methods

GetEmbeddedResourceNamespace()

Returns the optional namespace of the embedded DLL resources that should be served by the web plugin's url resource path.

Declaration
string GetEmbeddedResourceNamespace()
Returns
Type Description
System.String

GetFontAwesomeIcon()

Returns the optional font awesome class to use for the menu link. More information about FontAwesome and the list of available icons can be found here https://fontawesome.com/

Declaration
string GetFontAwesomeIcon()
Returns
Type Description
System.String

GetMenuTitle()

Returns the name that this plugin should represent on the websites side navigation.

Declaration
LocString GetMenuTitle()
Returns
Type Description
LocString

GetPluginIndexUrl()

Returns the index url to load into the website when this plugin is selected. If not provided it will load the index.html out of the the plugin's file providers.

Declaration
string GetPluginIndexUrl()
Returns
Type Description
System.String

GetStaticFilesPath()

Returns the optional path to the local static files that should be served by the web plugin's url resource path. This folder should be relative to the mod's DLL location.

Declaration
string GetStaticFilesPath()
Returns
Type Description
System.String

Extension Methods