IModule Interface

Manage an AskiaPortal module

Namespace: AskiaPortalCmn
Assembly: AskiaPortalCmn (in AskiaPortalCmn.dll) Version: 1.7.0-build068

Syntax

public interface IModule

Public Interface IModule

public interface class IModule

The IModule type exposes the following members.

Properties

	Name	Description
	Authors	Get the company, web site, name, email of the module author(s)
	Category	Get the category of the module.
	Description	Get the description of the module
	Guid	Get the unique identifier of the module
	IsBackground	Indicates if the module is a background module. A background module, doesn't have a frontal User Interface.
	Name	Get the name of the module
	RootUrl	Get the root URL of the module (relative to the AskiaPortal installation)
	State	Get the state of the module.
	Urls	Get the relative URLs associated with the module (relative to the `RootUrl` of the module)
	Version	Get the current module version

Methods

	Name	Description
	Activate	Activate the module.
	Deactivate	Deactivate the module.
	GetAllAccessItems	Returns the list of all access items for the current module.
	GetAllSurveyIds	Returns the list of all survey identifiers that is managed by the current module.
	Save	Update the module information.