Class ModuleDefinition

Namespace

Oqtane.Models

Assembly

Oqtane.Shared.dll

Describes a Module type (Definition) in Oqtane. The available Modules are determined at StartUp.

public class ModuleDefinition : ModelBase, IAuditable

Inheritance

object

ModelBase

ModuleDefinition

Implements

IAuditable

Inherited Members

ModelBase.CreatedBy

ModelBase.CreatedOn

ModelBase.ModifiedBy

ModelBase.ModifiedOn

Properties

AssemblyName

[NotMapped]
public string AssemblyName { get; set; }

Property Value

string

Categories

Categories this Module will be shown in (in the admin-dialogs)

public string Categories { get; set; }

Property Value

string

Contact

[NotMapped]
public string Contact { get; set; }

Property Value

string

ControlTypeRoutes

[NotMapped]
public string ControlTypeRoutes { get; set; }

Property Value

string

ControlTypeTemplate

[NotMapped]
public string ControlTypeTemplate { get; set; }

Property Value

string

DefaultAction

[NotMapped]
public string DefaultAction { get; set; }

Property Value

string

Dependencies

[NotMapped]
public string Dependencies { get; set; }

Property Value

string

Description

Module description for admin dialogs.

public string Description { get; set; }

Property Value

string

IsAutoEnabled

[NotMapped]
public bool IsAutoEnabled { get; set; }

Property Value

bool

IsEnabled

[NotMapped]
public bool IsEnabled { get; set; }

Property Value

bool

IsPortable

[NotMapped]
public bool IsPortable { get; set; }

Property Value

bool

License

[NotMapped]
public string License { get; set; }

Property Value

string

ModuleDefinitionId

Reference to the ModuleDefinition.

public int ModuleDefinitionId { get; set; }

Property Value

int

ModuleDefinitionName

Name of the ModuleDefinition

public string ModuleDefinitionName { get; set; }

Property Value

string

Name

Friendly name to show in UI

public string Name { get; set; }

Property Value

string

Owner

[NotMapped]
public string Owner { get; set; }

Property Value

string

PackageName

[NotMapped]
public string PackageName { get; set; }

Property Value

string

PageTemplates

[NotMapped]
public List<PageTemplate> PageTemplates { get; set; }

Property Value

List<PageTemplate>

PermissionList

[NotMapped]
public List<Permission> PermissionList { get; set; }

Property Value

List<Permission>

PermissionNames

[NotMapped]
public string PermissionNames { get; set; }

Property Value

string

Permissions

[Obsolete("The Permissions property is deprecated. Use PermissionList instead", false)]
[NotMapped]
[JsonIgnore]
public string Permissions { get; set; }

Property Value

string

ReleaseVersions

ReleaseVersions contains a comma delimited list of all official release versions of a module ie "1.0.0,1.0.1" Must be set for modules which use SQL scripts or include version-based logic in IInstallable implementations

[NotMapped]
public string ReleaseVersions { get; set; }

Property Value

string

Resources

[NotMapped]
public List<Resource> Resources { get; set; }

Property Value

List<Resource>

Runtimes

[NotMapped]
public string Runtimes { get; set; }

Property Value

string

ServerManagerType

[NotMapped]
public string ServerManagerType { get; set; }

Property Value

string

SettingsType

[NotMapped]
public string SettingsType { get; set; }

Property Value

string

SiteId

[NotMapped]
public int SiteId { get; set; }

Property Value

int

Template

[NotMapped]
public string Template { get; set; }

Property Value

string

Url

[NotMapped]
public string Url { get; set; }

Property Value

string

Version

Version information of this Module based on the DLL / NuGet package.

public string Version { get; set; }

Property Value

string