Interface IHostController

Interface of HostController.

Namespace: DotNetNuke.Entities.Controllers

Assembly: DotNetNuke.dll

Syntax

public interface IHostController

Examples

public static bool CheckUpgrade
{
    get
    {
        return HostController.Instance.GetBoolean("CheckUpgrade", true);
    }
}

Methods

GetBoolean(String, Boolean)

Gets the setting value for the specific key.

Declaration

bool GetBoolean(string key, bool defaultValue)

Parameters

Type	Name	Description
System.String	key	The setting key string.
System.Boolean	defaultValue	Default value returned if the setting is not found or not compatible with the requested type.

Returns

Type	Description
System.Boolean	host setting or the provided default value as a .

See Also

HostController

GetBoolean(String)

Gets the setting value for the specific key.

Declaration

bool GetBoolean(string key)

Parameters

Type	Name	Description
System.String	key	The setting key string.

Returns

Type	Description
System.Boolean	host setting as a boolean.

See Also

HostController

GetDouble(String, Double)

Gets the setting value for the specific key.

Declaration

double GetDouble(string key, double defaultValue)

Parameters

Type	Name	Description
System.String	key	The setting key string.
System.Double	defaultValue	Default value returned if the setting is not found or not compatible with the requested type.

Returns

Type	Description
System.Double	Host setting or the provided default value as a .

See Also

HostController

GetDouble(String)

Gets the setting value for the specific key.

Declaration

double GetDouble(string key)

Parameters

Type	Name	Description
System.String	key	The setting key string.

Returns

Type	Description
System.Double	Host setting as a .

See Also

HostController

GetEncryptedString(String, String)

Gets an encrypted host setting as a .

Declaration

string GetEncryptedString(string key, string passPhrase)

Parameters

Type	Name	Description
System.String	key	The setting key string.
System.String	passPhrase	The passPhrase used to decrypt the setting value.

Returns

Type	Description
System.String	The setting value as a .

See Also

HostController

GetInteger(String, Int32)

Gets the setting value for the specific key.

Declaration

int GetInteger(string key, int defaultValue)

Parameters

Type	Name	Description
System.String	key	The setting key string.
System.Int32	defaultValue	Default value returned if the setting is not found or not compatible with the requested type.

Returns

Type	Description
System.Int32	Host setting or provided default value as a .

See Also

HostController

GetInteger(String)

Gets the setting value for the specific key.

Declaration

int GetInteger(string key)

Parameters

Type	Name	Description
System.String	key	The setting key string.

Returns

Type	Description
System.Int32	Host setting as an .

See Also

HostController

GetSettings()

Gets the host settings.

Declaration

Dictionary<string, ConfigurationSetting> GetSettings()

Returns

Type	Description
Dictionary<System.String, ConfigurationSetting>	Host settings as a .

See Also

HostController

GetSettingsDictionary()

Gets the host settings.

Declaration

Dictionary<string, string> GetSettingsDictionary()

Returns

Type	Description
Dictionary<System.String, System.String>	Host settings as a .

See Also

HostController

GetString(String, String)

Gets the setting value for a specific key.

Declaration

string GetString(string key, string defaultValue)

Parameters

Type	Name	Description
System.String	key	The seeting key string.
System.String	defaultValue

Returns

Type	Description
System.String	Default value returned if the setting is not found.

See Also

HostController

GetString(String)

Gets the setting value for a specific key.

Declaration

string GetString(string key)

Parameters

Type	Name	Description
System.String	key	The setting key string.

Returns

Type	Description
System.String	The setting value as a .

See Also

HostController

IncrementCrmVersion(Boolean)

Increments the Client Resource Manager (CRM) version to bust local cache.

Declaration

void IncrementCrmVersion(bool includeOverridingPortals)

Parameters

Type	Name	Description
System.Boolean	includeOverridingPortals	If true also forces a CRM version increment on portals that have non-default settings for CRM.

See Also

HostController

Update(Dictionary<String, String>)

Updates the specified settings.

Declaration

void Update(Dictionary<string, string> settings)

Parameters

Type	Name	Description
Dictionary<System.String, System.String>	settings	The settings to update.

See Also

HostController

Update(ConfigurationSetting, Boolean)

Updates the specified config, ontionally clearing the cache.

Declaration

void Update(ConfigurationSetting config, bool clearCache)

Parameters

Type	Name	Description
ConfigurationSetting	config	The configuaration setting.
System.Boolean	clearCache	If set to true, will clear the cache after updating the setting.

See Also

HostController

Update(ConfigurationSetting)

Updates the specified config.

Declaration

void Update(ConfigurationSetting config)

Parameters

Type	Name	Description
ConfigurationSetting	config	The configuration setting.

See Also

HostController

Update(String, String, Boolean)

Updates the setting for a specific key.

Declaration

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

Parameters

Type	Name	Description
System.String	key	The setting key string.
System.String	value	The value to update.
System.Boolean	clearCache	If set to true, will clear the cache after updating the setting.

See Also

HostController

Update(String, String)

Updates the setting for a specific key.

Declaration

void Update(string key, string value)

Parameters

Type	Name	Description
System.String	key	The setting key string.
System.String	value	The value to update.

See Also

HostController

UpdateEncryptedString(String, String, String)

Takes in a value, encrypts it with a FIPS compliant algorithm and stores.

Declaration

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

Parameters

Type	Name	Description
System.String	key	host settings key.
System.String	value	host settings value.
System.String	passPhrase	pass phrase to allow encryption/decryption.

See Also

HostController

Extension Methods

JsonExtensionsWeb.ToJson(Object)

See Also

HostController