Class DesktopModuleController

DesktopModuleController provides the Business Layer for Desktop Modules.

Inheritance

System.Object

DesktopModuleController

Namespace: DotNetNuke.Entities.Modules

Assembly: DotNetNuke.dll

Syntax

public class DesktopModuleController : object

Methods

| Improve this Doc View Source

AddDesktopModulesToPortal(Int32)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static void AddDesktopModulesToPortal(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

| Improve this Doc View Source

AddDesktopModuleToPortal(Int32, DesktopModuleInfo, DesktopModulePermissionCollection, Boolean)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static int AddDesktopModuleToPortal(int portalID, DesktopModuleInfo desktopModule, DesktopModulePermissionCollection permissions, bool clearCache)

Parameters

Type	Name	Description
System.Int32	portalID
DesktopModuleInfo	desktopModule
DesktopModulePermissionCollection	permissions
System.Boolean	clearCache

Returns

Type	Description
System.Int32

| Improve this Doc View Source

AddDesktopModuleToPortal(Int32, Int32, Boolean, Boolean)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static int AddDesktopModuleToPortal(int portalId, int desktopModuleId, bool addPermissions, bool clearCache)

Parameters

Type	Name	Description
System.Int32	portalId
System.Int32	desktopModuleId
System.Boolean	addPermissions
System.Boolean	clearCache

Returns

Type	Description
System.Int32

| Improve this Doc View Source

AddDesktopModuleToPortals(Int32)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static void AddDesktopModuleToPortals(int desktopModuleId)

Parameters

Type	Name	Description
System.Int32	desktopModuleId

| Improve this Doc View Source

AddModuleCategory(String)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static void AddModuleCategory(string category)

Parameters

Type	Name	Description
System.String	category

| Improve this Doc View Source

DeleteDesktopModule(DesktopModuleInfo)

DeleteDesktopModule deletes a Desktop Module.

Declaration

public void DeleteDesktopModule(DesktopModuleInfo objDesktopModule)

Parameters

Type	Name	Description
DesktopModuleInfo	objDesktopModule	Desktop Module Info.

| Improve this Doc View Source

DeleteDesktopModule(Int32)

DeleteDesktopModule deletes a Desktop Module By ID.

Declaration

public void DeleteDesktopModule(int desktopModuleID)

Parameters

Type	Name	Description
System.Int32	desktopModuleID	The ID of the Desktop Module to delete.

| Improve this Doc View Source

DeleteDesktopModule(String)

DeleteDesktopModule deletes a Desktop Module.

Declaration

public static void DeleteDesktopModule(string moduleName)

Parameters

Type	Name	Description
System.String	moduleName	The Name of the Desktop Module to delete.

| Improve this Doc View Source

GetDesktopModule(Int32, Int32)

GetDesktopModule gets a Desktop Module by its ID.

Declaration

public static DesktopModuleInfo GetDesktopModule(int desktopModuleID, int portalID)

Parameters

Type	Name	Description
System.Int32	desktopModuleID	The ID of the Desktop Module to get.
System.Int32	portalID	The ID of the portal.

Returns

Type	Description
DesktopModuleInfo	The DesktopModuleInfo or null.

Remarks

This method uses the cached Dictionary of DesktopModules. It first checks if the DesktopModule is in the cache. If it is not in the cache it then makes a call to the Dataprovider.

| Improve this Doc View Source

GetDesktopModuleByFriendlyName(String)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static DesktopModuleInfo GetDesktopModuleByFriendlyName(string friendlyName)

Parameters

Type	Name	Description
System.String	friendlyName

Returns

Type	Description
DesktopModuleInfo

| Improve this Doc View Source

GetDesktopModuleByModuleName(String, Int32)

GetDesktopModuleByModuleName gets a Desktop Module by its Name.

Declaration

public static DesktopModuleInfo GetDesktopModuleByModuleName(string moduleName, int portalID)

Parameters

Type	Name	Description
System.String	moduleName	The name of the Desktop Module to get.
System.Int32	portalID	The ID of the portal.

Returns

Type	Description
DesktopModuleInfo	The DesktopModuleInfo or null.

Remarks

This method uses the cached Dictionary of DesktopModules. It first checks if the DesktopModule is in the cache. If it is not in the cache it then makes a call to the Dataprovider.

| Improve this Doc View Source

GetDesktopModuleByPackageID(Int32)

GetDesktopModuleByPackageID gets a Desktop Module by its Package ID.

Declaration

public static DesktopModuleInfo GetDesktopModuleByPackageID(int packageID)

Parameters

Type	Name	Description
System.Int32	packageID	The ID of the Package.

Returns

Type	Description
DesktopModuleInfo	The DesktopModuleInfo or null.

| Improve this Doc View Source

GetDesktopModules(Int32)

GetDesktopModules gets a Dictionary of Desktop Modules.

Declaration

public static Dictionary<int, DesktopModuleInfo> GetDesktopModules(int portalID)

Parameters

Type	Name	Description
System.Int32	portalID	The ID of the Portal (Use PortalID = Null.NullInteger (-1) to get all the DesktopModules including Modules not allowed for the current portal).

Returns

Type	Description
Dictionary<System.Int32, DesktopModuleInfo>	A new mapping desktop module ID to DesktopModuleInfo.

| Improve this Doc View Source

GetPortalDesktopModule(Int32, Int32)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static PortalDesktopModuleInfo GetPortalDesktopModule(int portalId, int desktopModuleId)

Parameters

Type	Name	Description
System.Int32	portalId
System.Int32	desktopModuleId

Returns

Type	Description
PortalDesktopModuleInfo

| Improve this Doc View Source

GetPortalDesktopModules(Int32)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static SortedList<string, PortalDesktopModuleInfo> GetPortalDesktopModules(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

Returns

Type	Description
SortedList<System.String, PortalDesktopModuleInfo>

| Improve this Doc View Source

GetPortalDesktopModulesByDesktopModuleID(Int32)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static Dictionary<int, PortalDesktopModuleInfo> GetPortalDesktopModulesByDesktopModuleID(int desktopModuleId)

Parameters

Type	Name	Description
System.Int32	desktopModuleId

Returns

Type	Description
Dictionary<System.Int32, PortalDesktopModuleInfo>

| Improve this Doc View Source

GetPortalDesktopModulesByPortalID(Int32)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static Dictionary<int, PortalDesktopModuleInfo> GetPortalDesktopModulesByPortalID(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

Returns

Type	Description
Dictionary<System.Int32, PortalDesktopModuleInfo>

| Improve this Doc View Source

RemoveDesktopModuleFromPortal(Int32, Int32, Boolean)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static void RemoveDesktopModuleFromPortal(int portalId, int desktopModuleId, bool clearCache)

Parameters

Type	Name	Description
System.Int32	portalId
System.Int32	desktopModuleId
System.Boolean	clearCache

| Improve this Doc View Source

RemoveDesktopModuleFromPortals(Int32)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static void RemoveDesktopModuleFromPortals(int desktopModuleId)

Parameters

Type	Name	Description
System.Int32	desktopModuleId

| Improve this Doc View Source

RemoveDesktopModulesFromPortal(Int32)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static void RemoveDesktopModulesFromPortal(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

| Improve this Doc View Source

SaveDesktopModule(DesktopModuleInfo, Boolean, Boolean)

SaveDesktopModule saves the Desktop Module to the database.

Declaration

public static int SaveDesktopModule(DesktopModuleInfo desktopModule, bool saveChildren, bool clearCache)

Parameters

Type	Name	Description
DesktopModuleInfo	desktopModule	The Desktop Module to save.
System.Boolean	saveChildren	A flag that determines whether the child objects are also saved.
System.Boolean	clearCache	A flag that determines whether to clear the host cache.

Returns

Type	Description
System.Int32	The desktop module ID.

| Improve this Doc View Source

SerializePortalDesktopModules(XmlWriter, Int32)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public static void SerializePortalDesktopModules(XmlWriter writer, int portalId)

Parameters

Type	Name	Description
XmlWriter	writer
System.Int32	portalId

| Improve this Doc View Source

UpdateModuleInterfaces(ref DesktopModuleInfo, String, Boolean)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public void UpdateModuleInterfaces(ref DesktopModuleInfo desktopModuleInfo, string sender, bool forceAppRestart)

Parameters

Type	Name	Description
DesktopModuleInfo	desktopModuleInfo
System.String	sender
System.Boolean	forceAppRestart

| Improve this Doc View Source

UpdateModuleInterfaces(ref DesktopModuleInfo)

DesktopModuleController provides the Business Layer for Desktop Modules.

Declaration

public void UpdateModuleInterfaces(ref DesktopModuleInfo desktopModuleInfo)

Parameters

Type	Name	Description
DesktopModuleInfo	desktopModuleInfo

Extension Methods

JsonExtensionsWeb.ToJson(Object)