Class DesktopModuleController

Inheritance

object

DesktopModuleController

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DotNetNuke.Entities.Modules

Assembly: DotNetNuke.dll

Syntax

public class DesktopModuleController

Constructors

DesktopModuleController()

Declaration

[Obsolete("Deprecated in DotNetNuke 10.2.2. Please use overload with IEventLogger. Scheduled removal in v12.0.0.")]
public DesktopModuleController()

DesktopModuleController(IEventLogger)

Declaration

public DesktopModuleController(IEventLogger eventLogger)

Parameters

Type	Name	Description
IEventLogger	eventLogger

Methods

AddDesktopModuleToPortal(IEventLogger, IPermissionDefinitionService, int, int, bool, bool)

Declaration

public static int AddDesktopModuleToPortal(IEventLogger eventLogger, IPermissionDefinitionService permissionDefinitionService, int portalId, int desktopModuleId, bool addPermissions, bool clearCache)

Parameters

Type	Name	Description
IEventLogger	eventLogger
IPermissionDefinitionService	permissionDefinitionService
int	portalId
int	desktopModuleId
bool	addPermissions
bool	clearCache

Returns

Type	Description
int

AddDesktopModuleToPortal(int, DesktopModuleInfo, DesktopModulePermissionCollection, bool)

Declaration

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

Parameters

Type	Name	Description
int	portalID
DesktopModuleInfo	desktopModule
DesktopModulePermissionCollection	permissions
bool	clearCache

Returns

Type	Description
int

AddDesktopModuleToPortal(int, int, bool, bool)

Declaration

[Obsolete("Deprecated in DotNetNuke 10.2.2. Use overload taking IEventLogger. Scheduled for removal in v12.0.0.")]
public static int AddDesktopModuleToPortal(int portalId, int desktopModuleId, bool addPermissions, bool clearCache)

Parameters

Type	Name	Description
int	portalId
int	desktopModuleId
bool	addPermissions
bool	clearCache

Returns

Type	Description
int

AddDesktopModuleToPortals(int)

Declaration

public static void AddDesktopModuleToPortals(int desktopModuleId)

Parameters

Type	Name	Description
int	desktopModuleId

AddDesktopModulesToPortal(int)

Declaration

public static void AddDesktopModulesToPortal(int portalId)

Parameters

Type	Name	Description
int	portalId

AddModuleCategory(string)

Declaration

public static void AddModuleCategory(string category)

Parameters

Type	Name	Description
string	category

DeleteDesktopModule(DesktopModuleInfo)

Declaration

public void DeleteDesktopModule(DesktopModuleInfo objDesktopModule)

Parameters

Type	Name	Description
DesktopModuleInfo	objDesktopModule

DeleteDesktopModule(int)

Declaration

public void DeleteDesktopModule(int desktopModuleID)

Parameters

Type	Name	Description
int	desktopModuleID

DeleteDesktopModule(string)

Declaration

public static void DeleteDesktopModule(string moduleName)

Parameters

Type	Name	Description
string	moduleName

GetDesktopModule(int, int)

Declaration

public static DesktopModuleInfo GetDesktopModule(int desktopModuleID, int portalID)

Parameters

Type	Name	Description
int	desktopModuleID
int	portalID

Returns

Type	Description
DesktopModuleInfo

GetDesktopModuleByFriendlyName(string)

Declaration

public static DesktopModuleInfo GetDesktopModuleByFriendlyName(string friendlyName)

Parameters

Type	Name	Description
string	friendlyName

Returns

Type	Description
DesktopModuleInfo

GetDesktopModuleByModuleName(string, int)

Declaration

public static DesktopModuleInfo GetDesktopModuleByModuleName(string moduleName, int portalID)

Parameters

Type	Name	Description
string	moduleName
int	portalID

Returns

Type	Description
DesktopModuleInfo

GetDesktopModuleByPackageID(int)

Declaration

public static DesktopModuleInfo GetDesktopModuleByPackageID(int packageID)

Parameters

Type	Name	Description
int	packageID

Returns

Type	Description
DesktopModuleInfo

GetDesktopModules(int)

Declaration

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

Parameters

Type	Name	Description
int	portalID

Returns

Type	Description
Dictionary<int, DesktopModuleInfo>

GetPortalDesktopModule(int, int)

Declaration

public static PortalDesktopModuleInfo GetPortalDesktopModule(int portalId, int desktopModuleId)

Parameters

Type	Name	Description
int	portalId
int	desktopModuleId

Returns

Type	Description
PortalDesktopModuleInfo

GetPortalDesktopModules(int)

Declaration

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

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
SortedList<string, PortalDesktopModuleInfo>

GetPortalDesktopModulesByDesktopModuleID(int)

Declaration

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

Parameters

Type	Name	Description
int	desktopModuleId

Returns

Type	Description
Dictionary<int, PortalDesktopModuleInfo>

GetPortalDesktopModulesByPortalID(int)

Declaration

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

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
Dictionary<int, PortalDesktopModuleInfo>

RemoveDesktopModuleFromPortal(IEventLogger, int, int, bool)

Declaration

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

Parameters

Type	Name	Description
IEventLogger	eventLogger
int	portalId
int	desktopModuleId
bool	clearCache

RemoveDesktopModuleFromPortal(int, int, bool)

Declaration

[Obsolete("Deprecated in DotNetNuke 10.2.2. Use overload taking IEventLogger. Scheduled for removal in v12.0.0.")]
public static void RemoveDesktopModuleFromPortal(int portalId, int desktopModuleId, bool clearCache)

Parameters

Type	Name	Description
int	portalId
int	desktopModuleId
bool	clearCache

RemoveDesktopModuleFromPortals(IEventLogger, int)

Declaration

public static void RemoveDesktopModuleFromPortals(IEventLogger eventLogger, int desktopModuleId)

Parameters

Type	Name	Description
IEventLogger	eventLogger
int	desktopModuleId

RemoveDesktopModuleFromPortals(int)

Declaration

[Obsolete("Deprecated in DotNetNuke 10.2.2. Use overload taking IEventLogger. Scheduled for removal in v12.0.0.")]
public static void RemoveDesktopModuleFromPortals(int desktopModuleId)

Parameters

Type	Name	Description
int	desktopModuleId

RemoveDesktopModulesFromPortal(IEventLogger, int)

Declaration

public static void RemoveDesktopModulesFromPortal(IEventLogger eventLogger, int portalId)

Parameters

Type	Name	Description
IEventLogger	eventLogger
int	portalId

RemoveDesktopModulesFromPortal(int)

Declaration

[Obsolete("Deprecated in DotNetNuke 10.2.2. Use overload taking IEventLogger. Scheduled for removal in v12.0.0.")]
public static void RemoveDesktopModulesFromPortal(int portalId)

Parameters

Type	Name	Description
int	portalId

SaveDesktopModule(IEventLogger, DesktopModuleInfo, bool, bool)

Declaration

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

Parameters

Type	Name	Description
IEventLogger	eventLogger
DesktopModuleInfo	desktopModule
bool	saveChildren
bool	clearCache

Returns

Type	Description
int

SaveDesktopModule(DesktopModuleInfo, bool, bool)

Declaration

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

Parameters

Type	Name	Description
DesktopModuleInfo	desktopModule
bool	saveChildren
bool	clearCache

Returns

Type	Description
int

SerializePortalDesktopModules(XmlWriter, int)

Declaration

public static void SerializePortalDesktopModules(XmlWriter writer, int portalId)

Parameters

Type	Name	Description
XmlWriter	writer
int	portalId

UpdateModuleInterfaces(ref DesktopModuleInfo)

Declaration

public void UpdateModuleInterfaces(ref DesktopModuleInfo desktopModuleInfo)

Parameters

Type	Name	Description
DesktopModuleInfo	desktopModuleInfo

UpdateModuleInterfaces(ref DesktopModuleInfo, string, bool)

Declaration

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

Parameters

Type	Name	Description
DesktopModuleInfo	desktopModuleInfo
string	sender
bool	forceAppRestart

Extension Methods

JsonExtensionsWeb.ToJson(object)