Class Personalization
Provides access to user personalization.
Inheritance
Namespace: DotNetNuke.Services.Personalization
Assembly: DotNetNuke.dll
Syntax
public class Personalization : object
Methods
| Improve this Doc View SourceGetProfile(PersonalizationInfo, String, String)
extract value base on naming container and key from PersonalizationInfo object.
Declaration
public static object GetProfile(PersonalizationInfo personalization, string namingContainer, string key)
Parameters
| Type | Name | Description |
|---|---|---|
| PersonalizationInfo | personalization | Object containing user personalization info. |
| System.String | namingContainer | Container for related set of values. |
| System.String | key | Individual profile key. |
Returns
| Type | Description |
|---|---|
| System.Object | The profile as an object. |
GetProfile(String, String)
load users profile and extract value base on naming container and key.
Declaration
public static object GetProfile(string namingContainer, string key)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | namingContainer | Container for related set of values. |
| System.String | key | Individual profile key. |
Returns
| Type | Description |
|---|---|
| System.Object | The profile as an object. |
GetSecureProfile(PersonalizationInfo, String, String)
extract value base on naming container and key from PersonalizationInfo object function will automatically decrypt value to plaintext.
Declaration
public static object GetSecureProfile(PersonalizationInfo personalization, string namingContainer, string key)
Parameters
| Type | Name | Description |
|---|---|---|
| PersonalizationInfo | personalization | Object containing user personalization info. |
| System.String | namingContainer | Container for related set of values. |
| System.String | key | Individual profile key. |
Returns
| Type | Description |
|---|---|
| System.Object | The profile as an object. |
GetSecureProfile(String, String)
load users profile and extract secure value base on naming container and key.
Declaration
public static object GetSecureProfile(string namingContainer, string key)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | namingContainer | Container for related set of values. |
| System.String | key | Individual profile key. |
Returns
| Type | Description |
|---|---|
| System.Object | The profile as an object. |
GetUserMode()
Gets the mode the user is viewing the page in.
Declaration
public static PortalSettings.Mode GetUserMode()
Returns
| Type | Description |
|---|---|
| PortalSettings.Mode |
RemoveProfile(PersonalizationInfo, String, String)
remove value from users PersonalizationInfo object (if it exists) uses namingcontainer and key to locate approriate value.
Declaration
public static void RemoveProfile(PersonalizationInfo personalization, string namingContainer, string key)
Parameters
| Type | Name | Description |
|---|---|---|
| PersonalizationInfo | personalization | Object containing user personalization info. |
| System.String | namingContainer | Container for related set of values. |
| System.String | key | Individual profile key. |
RemoveProfile(String, String)
remove value from profile uses namingcontainer and key to locate approriate value.
Declaration
public static void RemoveProfile(string namingContainer, string key)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | namingContainer | Container for related set of values. |
| System.String | key | Individual profile key. |
SetProfile(PersonalizationInfo, String, String, Object)
persist value stored in PersonalizationInfo obhect - use naming container and key to organize.
Declaration
public static void SetProfile(PersonalizationInfo personalization, string namingContainer, string key, object value)
Parameters
| Type | Name | Description |
|---|---|---|
| PersonalizationInfo | personalization | Object containing user personalization info. |
| System.String | namingContainer | Container for related set of values. |
| System.String | key | Individual profile key. |
| System.Object | value | Individual profile value. |
SetProfile(String, String, Object)
persist profile value -use naming container and key to orgainize.
Declaration
public static void SetProfile(string namingContainer, string key, object value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | namingContainer | Container for related set of values. |
| System.String | key | Individual profile key. |
| System.Object | value | Individual profile value. |
SetSecureProfile(PersonalizationInfo, String, String, Object)
persist profile value from PersonalizationInfo object, using naming container and key to organise function will automatically encrypt the value to plaintext.
Declaration
public static void SetSecureProfile(PersonalizationInfo personalization, string namingContainer, string key, object value)
Parameters
| Type | Name | Description |
|---|---|---|
| PersonalizationInfo | personalization | Object containing user personalization info. |
| System.String | namingContainer | Container for related set of values. |
| System.String | key | Individual profile key. |
| System.Object | value | Individual profile value. |
SetSecureProfile(String, String, Object)
persist profile value -use naming container and key to orgainize function calls an overload which automatically encrypts the value.
Declaration
public static void SetSecureProfile(string namingContainer, string key, object value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | namingContainer | Object containing user personalization info. |
| System.String | key | Individual profile key. |
| System.Object | value | Individual profile value. |