Interface IPortalController

Namespace: DotNetNuke.Entities.Portals
Assembly: DotNetNuke.dll
Syntax
public interface IPortalController

Methods

AddPortalAlias(int, string)

Declaration
void AddPortalAlias(int portalId, string portalAlias)
Parameters
Type Name Description
int portalId
string portalAlias

CopyPageTemplate(string, string)

Declaration
void CopyPageTemplate(string templateFile, string mappedHomeDirectory)
Parameters
Type Name Description
string templateFile
string mappedHomeDirectory

CreatePortal(string, UserInfo, string, string, IPortalTemplateInfo, string, string, string, string, bool)

Declaration
int CreatePortal(string portalName, UserInfo adminUser, string description, string keyWords, IPortalTemplateInfo template, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Type Name Description
string portalName
UserInfo adminUser
string description
string keyWords
IPortalTemplateInfo template
string homeDirectory
string portalAlias
string serverPath
string childPath
bool isChildPortal
Returns
Type Description
int

CreatePortal(string, UserInfo, string, string, PortalTemplateInfo, string, string, string, string, bool)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.11.1. Use IPortalTemplateInfo template argument instead. Scheduled removal in v11.0.0.")]
int CreatePortal(string portalName, UserInfo adminUser, string description, string keyWords, PortalController.PortalTemplateInfo template, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Type Name Description
string portalName
UserInfo adminUser
string description
string keyWords
PortalController.PortalTemplateInfo template
string homeDirectory
string portalAlias
string serverPath
string childPath
bool isChildPortal
Returns
Type Description
int

CreatePortal(string, int, string, string, IPortalTemplateInfo, string, string, string, string, bool)

Declaration
int CreatePortal(string portalName, int adminUserId, string description, string keyWords, IPortalTemplateInfo template, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Type Name Description
string portalName
int adminUserId
string description
string keyWords
IPortalTemplateInfo template
string homeDirectory
string portalAlias
string serverPath
string childPath
bool isChildPortal
Returns
Type Description
int

CreatePortal(string, int, string, string, PortalTemplateInfo, string, string, string, string, bool)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.11.1. Use DotNetNuke.Entities.Portals.Templates.PortalTemplateInfo template argument instead. Scheduled removal in v11.0.0.")]
int CreatePortal(string portalName, int adminUserId, string description, string keyWords, PortalController.PortalTemplateInfo template, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Type Name Description
string portalName
int adminUserId
string description
string keyWords
PortalController.PortalTemplateInfo template
string homeDirectory
string portalAlias
string serverPath
string childPath
bool isChildPortal
Returns
Type Description
int

GetAvailablePortalTemplates()

Declaration
[Obsolete("Deprecated in DotNetNuke 9.11.1. Use DotNetNuke.Entities.Portals.Templates.PortalTemplateController.Instance.GetPortalTemplates instead. Scheduled removal in v11.0.0.")]
IList<PortalController.PortalTemplateInfo> GetAvailablePortalTemplates()
Returns
Type Description
IList<PortalController.PortalTemplateInfo>

GetCurrentPortalSettings()

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.2. Use GetCurrentSettings instead. Scheduled removal in v11.0.0.")]
PortalSettings GetCurrentPortalSettings()
Returns
Type Description
PortalSettings

GetCurrentSettings()

Declaration
IPortalSettings GetCurrentSettings()
Returns
Type Description
IPortalSettings

GetPortal(Guid)

Declaration
PortalInfo GetPortal(Guid uniqueId)
Parameters
Type Name Description
Guid uniqueId
Returns
Type Description
PortalInfo

GetPortal(int)

Declaration
PortalInfo GetPortal(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
PortalInfo

GetPortal(int, string)

Declaration
PortalInfo GetPortal(int portalId, string cultureCode)
Parameters
Type Name Description
int portalId
string cultureCode
Returns
Type Description
PortalInfo

GetPortalList(string)

Declaration
List<PortalInfo> GetPortalList(string cultureCode)
Parameters
Type Name Description
string cultureCode
Returns
Type Description
List<PortalInfo>

GetPortalSettings(int)

Declaration
Dictionary<string, string> GetPortalSettings(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
Dictionary<string, string>

GetPortalSettings(int, string)

Declaration
Dictionary<string, string> GetPortalSettings(int portalId, string cultureCode)
Parameters
Type Name Description
int portalId
string cultureCode
Returns
Type Description
Dictionary<string, string>

GetPortalSpaceUsedBytes(int)

Declaration
long GetPortalSpaceUsedBytes(int portalId = -1)
Parameters
Type Name Description
int portalId
Returns
Type Description
long

GetPortalTemplate(string, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.11.1. Use DotNetNuke.Entities.Portals.Templates.PortalTemplateController.Instance.GetPortalTemplate instead. Scheduled removal in v11.0.0.")]
PortalController.PortalTemplateInfo GetPortalTemplate(string templateFileName, string cultureCode)
Parameters
Type Name Description
string templateFileName
string cultureCode
Returns
Type Description
PortalController.PortalTemplateInfo

GetPortals()

Declaration
ArrayList GetPortals()
Returns
Type Description
ArrayList

HasSpaceAvailable(int, long)

Declaration
bool HasSpaceAvailable(int portalId, long fileSizeBytes)
Parameters
Type Name Description
int portalId
long fileSizeBytes
Returns
Type Description
bool

MapLocalizedSpecialPages(int, string)

Declaration
void MapLocalizedSpecialPages(int portalId, string cultureCode)
Parameters
Type Name Description
int portalId
string cultureCode

ParseTemplate(int, PortalTemplateInfo, int, PortalTemplateModuleAction, bool)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.11.1. Use DotNetNuke.Entities.Portals.Templates.PortalTemplateController.Instance.ApplyPortalTemplate instead. Scheduled removal in v11.0.0.")]
void ParseTemplate(int portalId, PortalController.PortalTemplateInfo template, int administratorId, PortalTemplateModuleAction mergeTabs, bool isNewPortal)
Parameters
Type Name Description
int portalId
PortalController.PortalTemplateInfo template
int administratorId
PortalTemplateModuleAction mergeTabs
bool isNewPortal

ProcessResourceFileExplicit(string, string)

Declaration
void ProcessResourceFileExplicit(string portalPath, string resoureceFile)
Parameters
Type Name Description
string portalPath
string resoureceFile

RemovePortalLocalization(int, string, bool)

Declaration
void RemovePortalLocalization(int portalId, string cultureCode, bool clearCache = true)
Parameters
Type Name Description
int portalId
string cultureCode
bool clearCache

UpdatePortalExpiry(int, string)

Declaration
void UpdatePortalExpiry(int portalId, string cultureCode)
Parameters
Type Name Description
int portalId
string cultureCode

UpdatePortalInfo(PortalInfo)

Declaration
void UpdatePortalInfo(PortalInfo portal)
Parameters
Type Name Description
PortalInfo portal

UpdatePortalSetting(int, string, string, bool, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.2.0. Use the overloaded one with the 'isSecure' parameter instead. Scheduled removal in v11.0.0.")]
void UpdatePortalSetting(int portalID, string settingName, string settingValue, bool clearCache, string cultureCode)
Parameters
Type Name Description
int portalID
string settingName
string settingValue
bool clearCache
string cultureCode

UpdatePortalSetting(int, string, string, bool, string, bool)

Declaration
void UpdatePortalSetting(int portalID, string settingName, string settingValue, bool clearCache, string cultureCode, bool isSecure)
Parameters
Type Name Description
int portalID
string settingName
string settingValue
bool clearCache
string cultureCode
bool isSecure

Extension Methods