Class PortalController
Inheritance
PortalController
Assembly: DotNetNuke.dll
Syntax
public class PortalController : ServiceLocator<IPortalController, PortalController>, IPortalController
Constructors
PortalController()
Declaration
public PortalController()
Fields
HttpContextKeyPortalSettingsDictionary
Declaration
protected const string HttpContextKeyPortalSettingsDictionary = "PortalSettingsDictionary{0}{1}"
Field Value
Methods
AddPortalAlias(int, string)
Declaration
public void AddPortalAlias(int portalId, string portalAlias)
Parameters
Type |
Name |
Description |
int |
portalId |
|
string |
portalAlias |
|
AddPortalDictionary(int, int)
Declaration
public static void AddPortalDictionary(int portalId, int tabId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
int |
tabId |
|
CheckDesktopModulesInstalled(XPathNavigator)
Declaration
public static string CheckDesktopModulesInstalled(XPathNavigator nav)
Parameters
Returns
CopyPageTemplate(string, string)
Declaration
public void CopyPageTemplate(string templateFile, string mappedHomeDirectory)
Parameters
Type |
Name |
Description |
string |
templateFile |
|
string |
mappedHomeDirectory |
|
CreateChildPortalFolder(string)
Declaration
public static string CreateChildPortalFolder(string childPath)
Parameters
Type |
Name |
Description |
string |
childPath |
|
Returns
CreatePortal(string, UserInfo, string, string, IPortalTemplateInfo, string, string, string, string, bool)
Declaration
public int CreatePortal(string portalName, UserInfo adminUser, string description, string keyWords, IPortalTemplateInfo template, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Returns
CreatePortal(string, UserInfo, string, string, PortalTemplateInfo, string, string, string, string, bool)
Declaration
[Obsolete("Deprecated in DotNetNuke 9.11.1. Use DotNetNuke.Entities.Portals.Templates.PortalTemplateInfo instead. Scheduled for removal in v11.0.0.")]
public int CreatePortal(string portalName, UserInfo adminUser, string description, string keyWords, PortalController.PortalTemplateInfo template, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Returns
CreatePortal(string, int, string, string, IPortalTemplateInfo, string, string, string, string, bool)
Declaration
public int CreatePortal(string portalName, int adminUserId, string description, string keyWords, IPortalTemplateInfo template, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Returns
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 instead. Scheduled for removal in v11.0.0.")]
public int CreatePortal(string portalName, int adminUserId, string description, string keyWords, PortalController.PortalTemplateInfo template, string homeDirectory, string portalAlias, string serverPath, string childPath, bool isChildPortal)
Parameters
Returns
DeleteExpiredPortals(string)
Declaration
public static void DeleteExpiredPortals(string serverPath)
Parameters
Type |
Name |
Description |
string |
serverPath |
|
DeletePortal(PortalInfo, string)
Declaration
public static string DeletePortal(PortalInfo portal, string serverPath)
Parameters
Returns
DeletePortalFolder(string, string)
Declaration
public static void DeletePortalFolder(string serverPath, string portalFolder)
Parameters
DeletePortalSetting(int, string)
Declaration
public static void DeletePortalSetting(int portalID, string settingName)
Parameters
Type |
Name |
Description |
int |
portalID |
|
string |
settingName |
|
DeletePortalSetting(int, string, string)
Declaration
public static void DeletePortalSetting(int portalID, string settingName, string cultureCode)
Parameters
DeletePortalSettings(int)
Declaration
public static void DeletePortalSettings(int portalID)
Parameters
Type |
Name |
Description |
int |
portalID |
|
DeletePortalSettings(int, string)
Declaration
public static void DeletePortalSettings(int portalID, string cultureCode)
Parameters
Type |
Name |
Description |
int |
portalID |
|
string |
cultureCode |
|
GetActivePortalLanguage(int)
Declaration
public static string GetActivePortalLanguage(int portalID)
Parameters
Type |
Name |
Description |
int |
portalID |
|
Returns
GetAvailablePortalTemplates()
Declaration
[Obsolete("Deprecated in DotNetNuke 9.11.1. Use DotNetNuke.Entities.Portals.Templates.PortalTemplateController.Instance.GetPortalTemplates instead. Scheduled for removal in v11.0.0.")]
public IList<PortalController.PortalTemplateInfo> GetAvailablePortalTemplates()
Returns
GetEffectivePortalId(int)
Declaration
public static int GetEffectivePortalId(int portalId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
Returns
GetEncryptedString(string, int, string)
Declaration
public static string GetEncryptedString(string settingName, int portalID, string passPhrase)
Parameters
Returns
GetExpiredPortals()
Declaration
public static ArrayList GetExpiredPortals()
Returns
GetFactory()
Declaration
protected override Func<IPortalController> GetFactory()
Returns
Overrides
GetPortal(Guid)
Declaration
public PortalInfo GetPortal(Guid uniqueId)
Parameters
Type |
Name |
Description |
Guid |
uniqueId |
|
Returns
GetPortal(int)
Declaration
public PortalInfo GetPortal(int portalId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
Returns
GetPortal(int, string)
Declaration
public PortalInfo GetPortal(int portalId, string cultureCode)
Parameters
Type |
Name |
Description |
int |
portalId |
|
string |
cultureCode |
|
Returns
GetPortalDefaultLanguage(int)
Declaration
public static string GetPortalDefaultLanguage(int portalID)
Parameters
Type |
Name |
Description |
int |
portalID |
|
Returns
GetPortalDictionary()
Declaration
public static Dictionary<int, int> GetPortalDictionary()
Returns
GetPortalFolder(string)
Declaration
public static string GetPortalFolder(string alias)
Parameters
Type |
Name |
Description |
string |
alias |
|
Returns
GetPortalList(string)
Declaration
public List<PortalInfo> GetPortalList(string cultureCode)
Parameters
Type |
Name |
Description |
string |
cultureCode |
|
Returns
GetPortalSetting(string, int, string)
Declaration
public static string GetPortalSetting(string settingName, int portalID, string defaultValue)
Parameters
Returns
GetPortalSetting(string, int, string, string)
Declaration
public static string GetPortalSetting(string settingName, int portalID, string defaultValue, string cultureCode)
Parameters
Returns
GetPortalSettingAsBoolean(string, int, bool)
Declaration
public static bool GetPortalSettingAsBoolean(string key, int portalID, bool defaultValue)
Parameters
Returns
GetPortalSettingAsBoolean(string, int, bool, string)
Declaration
public static bool GetPortalSettingAsBoolean(string key, int portalID, bool defaultValue, string cultureCode)
Parameters
Returns
GetPortalSettingAsDouble(string, int, double)
Declaration
public static double GetPortalSettingAsDouble(string key, int portalId, double defaultValue)
Parameters
Returns
GetPortalSettingAsInteger(string, int, int)
Declaration
public static int GetPortalSettingAsInteger(string key, int portalID, int defaultValue)
Parameters
Type |
Name |
Description |
string |
key |
|
int |
portalID |
|
int |
defaultValue |
|
Returns
GetPortalSettingAsInteger(string, int, int, string)
Declaration
public static int GetPortalSettingAsInteger(string key, int portalID, int defaultValue, string cultureCode)
Parameters
Returns
GetPortalSettings(int)
Declaration
public Dictionary<string, string> GetPortalSettings(int portalId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
Returns
GetPortalSettings(int, string)
Declaration
public Dictionary<string, string> GetPortalSettings(int portalId, string cultureCode)
Parameters
Type |
Name |
Description |
int |
portalId |
|
string |
cultureCode |
|
Returns
GetPortalSpaceUsedBytes(int)
Declaration
public long GetPortalSpaceUsedBytes(int portalId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
Returns
GetPortalTemplate(string, string)
Declaration
[Obsolete("Deprecated in DotNetNuke 9.11.1. Use DotNetNuke.Entities.Portals.Templates.PortalTemplateController.Instance.GetPortalTemplate instead. Scheduled for removal in v11.0.0.")]
public PortalController.PortalTemplateInfo GetPortalTemplate(string templatePath, string cultureCode)
Parameters
Type |
Name |
Description |
string |
templatePath |
|
string |
cultureCode |
|
Returns
GetPortals()
Declaration
public ArrayList GetPortals()
Returns
GetPortalsByName(string, int, int, ref int)
Declaration
public static ArrayList GetPortalsByName(string nameToMatch, int pageIndex, int pageSize, ref int totalRecords)
Parameters
Type |
Name |
Description |
string |
nameToMatch |
|
int |
pageIndex |
|
int |
pageSize |
|
int |
totalRecords |
|
Returns
GetPortalsByUser(int)
Declaration
public static ArrayList GetPortalsByUser(int userId)
Parameters
Type |
Name |
Description |
int |
userId |
|
Returns
HasSpaceAvailable(int, long)
Declaration
public bool HasSpaceAvailable(int portalId, long fileSizeBytes)
Parameters
Type |
Name |
Description |
int |
portalId |
|
long |
fileSizeBytes |
|
Returns
IncrementCrmVersion(int)
Declaration
public static void IncrementCrmVersion(int portalID)
Parameters
Type |
Name |
Description |
int |
portalID |
|
IncrementOverridingPortalsCrmVersion()
Declaration
public static void IncrementOverridingPortalsCrmVersion()
IsChildPortal(PortalInfo, string)
Declaration
public static bool IsChildPortal(PortalInfo portal, string serverPath)
Parameters
Returns
IsMemberOfPortalGroup(int)
Declaration
public static bool IsMemberOfPortalGroup(int portalId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
Returns
MapLocalizedSpecialPages(int, string)
Declaration
public 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 for removal in v11.0.0.")]
public void ParseTemplate(int portalId, PortalController.PortalTemplateInfo template, int administratorId, PortalTemplateModuleAction mergeTabs, bool isNewPortal)
Parameters
ProcessResourceFileExplicit(string, string)
Declaration
public void ProcessResourceFileExplicit(string portalPath, string resoureceFile)
Parameters
Type |
Name |
Description |
string |
portalPath |
|
string |
resoureceFile |
|
RemovePortalLocalization(int, string, bool)
Declaration
public void RemovePortalLocalization(int portalId, string cultureCode, bool clearCache = true)
Parameters
Type |
Name |
Description |
int |
portalId |
|
string |
cultureCode |
|
bool |
clearCache |
|
UpdateEncryptedString(int, string, string, string)
Declaration
public static void UpdateEncryptedString(int portalID, string settingName, string settingValue, string passPhrase)
Parameters
UpdatePortalDefaultLanguage(int, string)
Declaration
public static void UpdatePortalDefaultLanguage(int portalID, string cultureCode)
Parameters
Type |
Name |
Description |
int |
portalID |
|
string |
cultureCode |
|
UpdatePortalExpiry(int, string)
Declaration
public void UpdatePortalExpiry(int portalId, string cultureCode)
Parameters
Type |
Name |
Description |
int |
portalId |
|
string |
cultureCode |
|
UpdatePortalInfo(PortalInfo)
Declaration
public void UpdatePortalInfo(PortalInfo portal)
Parameters
UpdatePortalSetting(int, string, string)
Declaration
public static void UpdatePortalSetting(int portalID, string settingName, string settingValue)
Parameters
UpdatePortalSetting(int, string, string, bool)
Declaration
public static void UpdatePortalSetting(int portalID, string settingName, string settingValue, bool clearCache)
Parameters
UpdatePortalSetting(int, string, string, bool, string)
Declaration
public static void UpdatePortalSetting(int portalID, string settingName, string settingValue, bool clearCache, string cultureCode)
Parameters
UpdatePortalSetting(int, string, string, bool, string, bool)
Declaration
public static void UpdatePortalSetting(int portalID, string settingName, string settingValue, bool clearCache, string cultureCode, bool isSecure)
Parameters
UpdatePortalSetting(int, string, string, string)
Declaration
[Obsolete("Deprecated in DotNetNuke 9.2.0. Use the overload with the 'isSecure' parameter instead. Scheduled for removal in v11.0.0.")]
public static void UpdatePortalSetting(int portalID, string settingName, string settingValue, string cultureCode)
Parameters
Implements
Extension Methods