Class HostController

Inheritance

object

ComponentBase<IHostController, HostController>

HostController

Implements

IHostController

IHostSettingsService

Inherited Members

ComponentBase<IHostController, HostController>.RegisterInstance(IHostController)

ComponentBase<IHostController, HostController>.Instance

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DotNetNuke.Entities.Controllers

Assembly: DotNetNuke.dll

Syntax

public class HostController : ComponentBase<IHostController, HostController>, IHostController, IHostSettingsService

Constructors

HostController()

Declaration

public HostController()

Properties

Instance

Declaration

[Obsolete("Deprecated in DotNetNuke 9.7.1. Use DotNetNuke.Abstractions.IHostSettingsService instead. Scheduled removal in v11.0.0.")]
public static IHostController Instance { get; }

Property Value

Type	Description
IHostController

Methods

GetBoolean(string)

Declaration

public bool GetBoolean(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
bool

GetBoolean(string, bool)

Declaration

public bool GetBoolean(string key, bool defaultValue)

Parameters

Type	Name	Description
string	key
bool	defaultValue

Returns

Type	Description
bool

GetDouble(string)

Declaration

public double GetDouble(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
double

GetDouble(string, double)

Declaration

public double GetDouble(string key, double defaultValue)

Parameters

Type	Name	Description
string	key
double	defaultValue

Returns

Type	Description
double

GetEncryptedString(string, string)

Declaration

public string GetEncryptedString(string key, string passPhrase)

Parameters

Type	Name	Description
string	key
string	passPhrase

Returns

Type	Description
string

GetInteger(string)

Declaration

public int GetInteger(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
int

GetInteger(string, int)

Declaration

public int GetInteger(string key, int defaultValue)

Parameters

Type	Name	Description
string	key
int	defaultValue

Returns

Type	Description
int

GetSettings()

Declaration

[Obsolete("Deprecated in DotNetNuke 9.7.1. use DotNetNuke.Abstractions.IHostSettingsService instead. Scheduled for removal in v11.0.0.")]
public Dictionary<string, ConfigurationSetting> GetSettings()

Returns

Type	Description
Dictionary<string, ConfigurationSetting>

GetSettingsDictionary()

Declaration

[Obsolete("Deprecated in DotNetNuke 9.7.1. use DotNetNuke.Abstractions.IHostSettingsService instead. Scheduled for removal in v11.0.0.")]
public Dictionary<string, string> GetSettingsDictionary()

Returns

Type	Description
Dictionary<string, string>

GetString(string)

Declaration

public string GetString(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
string

GetString(string, string)

Declaration

public string GetString(string key, string defaultValue)

Parameters

Type	Name	Description
string	key
string	defaultValue

Returns

Type	Description
string

IncrementCrmVersion(bool)

Declaration

public void IncrementCrmVersion(bool includeOverridingPortals)

Parameters

Type	Name	Description
bool	includeOverridingPortals

Update(IConfigurationSetting)

Declaration

public void Update(IConfigurationSetting config)

Parameters

Type	Name	Description
IConfigurationSetting	config

Update(IConfigurationSetting, bool)

Declaration

public void Update(IConfigurationSetting config, bool clearCache)

Parameters

Type	Name	Description
IConfigurationSetting	config
bool	clearCache

Update(ConfigurationSetting)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.7.1. use DotNetNuke.Abstractions.IHostSettingsService instead. Scheduled for removal in v11.0.0.")]
public void Update(ConfigurationSetting config)

Parameters

Type	Name	Description
ConfigurationSetting	config

Update(ConfigurationSetting, bool)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.7.1. use DotNetNuke.Abstractions.IHostSettingsService instead. Scheduled for removal in v11.0.0.")]
public void Update(ConfigurationSetting config, bool clearCache)

Parameters

Type	Name	Description
ConfigurationSetting	config
bool	clearCache

Update(Dictionary<string, string>)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.7.1. use DotNetNuke.Abstractions.IHostSettingsService instead. Scheduled for removal in v11.0.0.")]
public void Update(Dictionary<string, string> settings)

Parameters

Type	Name	Description
Dictionary<string, string>	settings

Update(string, string)

Declaration

public void Update(string key, string value)

Parameters

Type	Name	Description
string	key
string	value

Update(string, string, bool)

Declaration

public void Update(string key, string value, bool clearCache)

Parameters

Type	Name	Description
string	key
string	value
bool	clearCache

UpdateEncryptedString(string, string, string)

Declaration

public void UpdateEncryptedString(string key, string value, string passPhrase)

Parameters

Type	Name	Description
string	key
string	value
string	passPhrase

Implements

IHostController

IHostSettingsService

Extension Methods

JsonExtensionsWeb.ToJson(object)