Document most core interfaces
This commit is contained in:
@ -1,4 +1,4 @@
|
||||
using Oqtane.Models;
|
||||
using Oqtane.Models;
|
||||
using Oqtane.Shared;
|
||||
using System.Collections.Generic;
|
||||
|
||||
@ -6,10 +6,29 @@ namespace Oqtane.Modules
|
||||
{
|
||||
public interface IModuleControl
|
||||
{
|
||||
SecurityAccessLevel SecurityAccessLevel { get; } // defines the security access level for this control - defaults to View
|
||||
string Title { get; } // title to display for this control - defaults to module title
|
||||
string Actions { get; } // allows for routing by configuration rather than by convention ( comma delimited ) - defaults to using component file name
|
||||
bool UseAdminContainer { get; } // container for embedding module control - defaults to true. false will suppress the default modal UI popup behavior and render the component in the page.
|
||||
List<Resource> Resources { get; } // identifies all resources in a module
|
||||
/// <summary>
|
||||
/// Defines the security access level for this control - defaults to View
|
||||
/// </summary>
|
||||
SecurityAccessLevel SecurityAccessLevel { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Title to display for this control - defaults to module title
|
||||
/// </summary>
|
||||
string Title { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Allows for routing by configuration rather than by convention ( comma delimited ) - defaults to using component file name
|
||||
/// </summary>
|
||||
string Actions { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Container for embedding module control - defaults to true. false will suppress the default modal UI popup behavior and render the component in the page.
|
||||
/// </summary>
|
||||
bool UseAdminContainer { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Identifies all resources in a module
|
||||
/// </summary>
|
||||
List<Resource> Resources { get; }
|
||||
}
|
||||
}
|
||||
|
Reference in New Issue
Block a user