Class UserProfile

The UserProfile class provides a Business Layer entity for the Users Profile.

Inheritance

System.Object

UserProfile

Namespace: DotNetNuke.Entities.Users

Assembly: DotNetNuke.dll

Syntax

public class UserProfile : object

Constructors

UserProfile()

Initializes a new instance of the UserProfile class.

Declaration

public UserProfile()

UserProfile(UserInfo)

Initializes a new instance of the UserProfile class with a proficed existing user.

Declaration

public UserProfile(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The user this profile belongs to.

Fields

USERPROFILE_Biography

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_Biography = null

Field Value

Type	Description
System.String

USERPROFILE_Cell

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_Cell = null

Field Value

Type	Description
System.String

USERPROFILE_City

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_City = null

Field Value

Type	Description
System.String

USERPROFILE_Country

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_Country = null

Field Value

Type	Description
System.String

USERPROFILE_Fax

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_Fax = null

Field Value

Type	Description
System.String

USERPROFILE_FirstName

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_FirstName = null

Field Value

Type	Description
System.String

USERPROFILE_IM

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_IM = null

Field Value

Type	Description
System.String

USERPROFILE_LastName

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_LastName = null

Field Value

Type	Description
System.String

USERPROFILE_Photo

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_Photo = null

Field Value

Type	Description
System.String

USERPROFILE_PostalCode

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_PostalCode = null

Field Value

Type	Description
System.String

USERPROFILE_PreferredLocale

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_PreferredLocale = null

Field Value

Type	Description
System.String

USERPROFILE_PreferredTimeZone

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_PreferredTimeZone = null

Field Value

Type	Description
System.String

USERPROFILE_Region

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_Region = null

Field Value

Type	Description
System.String

USERPROFILE_Street

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_Street = null

Field Value

Type	Description
System.String

USERPROFILE_Telephone

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_Telephone = null

Field Value

Type	Description
System.String

USERPROFILE_TimeZone

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_TimeZone = null

Field Value

Type	Description
System.String

USERPROFILE_Title

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_Title = null

Field Value

Type	Description
System.String

USERPROFILE_Unit

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_Unit = null

Field Value

Type	Description
System.String

USERPROFILE_Website

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public const string USERPROFILE_Website = null

Field Value

Type	Description
System.String

Properties

Biography

Gets or sets the biography.

Declaration

public string Biography { get; set; }

Property Value

Type	Description
System.String

Cell

Gets or sets the Cell/Mobile Phone.

Declaration

public string Cell { get; set; }

Property Value

Type	Description
System.String

City

Gets or sets the City part of the Address.

Declaration

public string City { get; set; }

Property Value

Type	Description
System.String

Country

Gets or sets the Country part of the Address.

Declaration

public string Country { get; set; }

Property Value

Type	Description
System.String

Fax

Gets or sets the Fax Phone.

Declaration

public string Fax { get; set; }

Property Value

Type	Description
System.String

FirstName

Gets or sets the First Name.

Declaration

public string FirstName { get; set; }

Property Value

Type	Description
System.String

FullName

Gets the full name by concatenating the first and last name with a space.

Declaration

public string FullName { get; }

Property Value

Type	Description
System.String

IM

Gets or sets the Instant Messenger Handle.

Declaration

public string IM { get; set; }

Property Value

Type	Description
System.String

IsDirty

Gets a value indicating whether a property has been changed.

Declaration

public bool IsDirty { get; }

Property Value

Type	Description
System.Boolean

Item[String]

The UserProfile class provides a Business Layer entity for the Users Profile.

Declaration

public object this[string name] { get; set; }

Parameters

Type	Name	Description
System.String	name

Property Value

Type	Description
System.Object

LastName

Gets or sets the Last Name.

Declaration

public string LastName { get; set; }

Property Value

Type	Description
System.String

Photo

Gets or sets the path to the profile picture.

Declaration

public string Photo { get; set; }

Property Value

Type	Description
System.String

PhotoURL

Gets a URL for the profile picture - if the path contains invalid url characters it will return a fileticket.

Declaration

public string PhotoURL { get; }

Property Value

Type	Description
System.String

PhotoURLFile

Gets the file path of the photo url (designed to be used when files are loaded via the filesystem e.g for caching).

Declaration

public string PhotoURLFile { get; }

Property Value

Type	Description
System.String

PostalCode

Gets or sets the PostalCode part of the Address.

Declaration

public string PostalCode { get; set; }

Property Value

Type	Description
System.String

PreferredLocale

Gets or sets the Preferred Locale.

Declaration

public string PreferredLocale { get; set; }

Property Value

Type	Description
System.String

PreferredTimeZone

Gets or sets the preferred time zone.

Declaration

public TimeZoneInfo PreferredTimeZone { get; set; }

Property Value

Type	Description
TimeZoneInfo

ProfileProperties

Gets the Collection of Profile Properties.

Declaration

public ProfilePropertyDefinitionCollection ProfileProperties { get; }

Property Value

Type	Description
ProfilePropertyDefinitionCollection

Region

Gets or sets the Region part of the Address.

Declaration

public string Region { get; set; }

Property Value

Type	Description
System.String

Street

Gets or sets the Street part of the Address.

Declaration

public string Street { get; set; }

Property Value

Type	Description
System.String

Telephone

Gets or sets the telephone number.

Declaration

public string Telephone { get; set; }

Property Value

Type	Description
System.String

Title

Gets or sets the Title.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String

Unit

Gets or sets the Unit part of the Address.

Declaration

public string Unit { get; set; }

Property Value

Type	Description
System.String

Website

Gets or sets the Website.

Declaration

public string Website { get; set; }

Property Value

Type	Description
System.String

Methods

ClearIsDirty()

Clears the IsDirty Flag.

Declaration

public void ClearIsDirty()

GetProperty(String)

Gets a Profile Property from the Profile.

Declaration

public ProfilePropertyDefinition GetProperty(string propName)

Parameters

Type	Name	Description
System.String	propName	The name of the property to retrieve.

Returns

Type	Description
ProfilePropertyDefinition	A profile property definition, ProfilePropertyDefinition.

Remarks

Used mainly for custom profile properties, many default properties are already exposed in this class.

GetPropertyValue(String)

Gets a Profile Property Value from the Profile.

Declaration

public string GetPropertyValue(string propName)

Parameters

Type	Name	Description
System.String	propName	The name of the property to retrieve.

Returns

Type	Description
System.String	A string representing the property value.

Remarks

Used mainly for custom profile properties, many default properties are already exposed in this class.

InitialiseProfile(Int32, Boolean)

Initialises the Profile with an empty collection of profile properties or default values.

Declaration

public void InitialiseProfile(int portalId, bool useDefaults)

Parameters

Type	Name	Description
System.Int32	portalId	the id of the portal this profile belongs to.
System.Boolean	useDefaults	A flag that indicates whether the profile default values should be copied to the Profile.

InitialiseProfile(Int32)

Initialises the Profile with a collection of profile properties and their default values.

Declaration

public void InitialiseProfile(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the portal this profile belongs to.

SetProfileProperty(String, String)

Sets a Profile Property Value in the Profile.

Declaration

public void SetProfileProperty(string propName, string propValue)

Parameters

Type	Name	Description
System.String	propName	The name of the propoerty to set.
System.String	propValue	The value of the propoerty to set.

Extension Methods

JsonExtensionsWeb.ToJson(Object)