Interface IFeaturePage
public interface IFeaturePageNamespace: HomeSeer.PluginSdk.Features
Assembly: PluginSdk.dll
The base implementation of a feature page in HS4.
Properties
View SourceFileName
The name of the HTML file that backs this feature page. Ex "my-feature.html"
Declaration
string FileName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Title
The title of the page. Displayed in the plugin menu and by the browser client.
Declaration
string Title { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
View SourceGetHtmlFragment(String)
Get a fragment of HTML attached to a particular ID.
Declaration
string GetHtmlFragment(string fragmentId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fragmentId | The ID of the fragment to get |
Returns
| Type | Description |
|---|---|
| System.String | A fragment of HTML |
Remarks
Used by Scriban.
PostBackProc(String, String, Int32)
Respond to an HTTP POST directed at this page.
Declaration
string PostBackProc(string data, string user, int userRights)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | data | The body of data attached to the POST |
| System.String | user | |
| System.Int32 | userRights |
Returns
| Type | Description |
|---|---|
| System.String | The data to return as a string. Use JSON. |