View Source

Class User

Represents a backoffice user

Inheritance

System.Object

BeingDirtyBase

EntityBase

Namespace: Umbraco.Cms.Core.Models.Membership

Assembly: Umbraco.Core.dll

Syntax

[DataContract(IsReference = true)]
public class User : EntityBase, IUser, IMembershipUser, IEntity, IDeepCloneable, IRememberBeingDirty, ICanBeDirty, IProfile

Constructors

User(GlobalSettings)

Constructor for creating a new/empty user

Declaration

public User(GlobalSettings globalSettings)

Parameters

Type	Name	Description
GlobalSettings	globalSettings

User(GlobalSettings, Int32, String, String, String, String, String, IEnumerable<IReadOnlyUserGroup>, Int32[], Int32[])

Constructor for creating a new User instance for an existing user

Declaration

public User(GlobalSettings globalSettings, int id, string name, string email, string username, string rawPasswordValue, string passwordConfig, IEnumerable<IReadOnlyUserGroup> userGroups, int[] startContentIds, int[] startMediaIds)

Parameters

Type	Name	Description
GlobalSettings	globalSettings
System.Int32	id
System.String	name
System.String	email
System.String	username
System.String	rawPasswordValue
System.String	passwordConfig
IEnumerable<IReadOnlyUserGroup>	userGroups
System.Int32[]	startContentIds
System.Int32[]	startMediaIds

User(GlobalSettings, String, String, String, String)

Constructor for creating a new/empty user

Declaration

public User(GlobalSettings globalSettings, string name, string email, string username, string rawPasswordValue)

Parameters

Type	Name	Description
GlobalSettings	globalSettings
System.String	name
System.String	email
System.String	username
System.String	rawPasswordValue

Properties

AllowedSections

Declaration

public IEnumerable<string> AllowedSections { get; }

Property Value

Type	Description
IEnumerable<System.String>

Avatar

Declaration

[DataMember]
public string Avatar { get; set; }

Property Value

Type	Description
System.String

Comments

Declaration

[IgnoreDataMember]
public string Comments { get; set; }

Property Value

Type	Description
System.String

Email

Declaration

[DataMember]
public string Email { get; set; }

Property Value

Type	Description
System.String

EmailConfirmedDate

Declaration

[DataMember]
public DateTime? EmailConfirmedDate { get; set; }

Property Value

Type	Description
System.Nullable<DateTime>

FailedPasswordAttempts

Declaration

[IgnoreDataMember]
public int FailedPasswordAttempts { get; set; }

Property Value

Type	Description
System.Int32

Groups

Gets the groups that user is part of

Declaration

[DataMember]
public IEnumerable<IReadOnlyUserGroup> Groups { get; }

Property Value

Type	Description
IEnumerable<IReadOnlyUserGroup>

InvitedDate

Declaration

[DataMember]
public DateTime? InvitedDate { get; set; }

Property Value

Type	Description
System.Nullable<DateTime>

IsApproved

Declaration

[DataMember]
public bool IsApproved { get; set; }

Property Value

Type	Description
System.Boolean

IsLockedOut

Declaration

[IgnoreDataMember]
public bool IsLockedOut { get; set; }

Property Value

Type	Description
System.Boolean

Kind

Declaration

[DataMember]
public UserKind Kind { get; set; }

Property Value

Type	Description
UserKind

Language

Declaration

[DataMember]
public string Language { get; set; }

Property Value

Type	Description
System.String

LastLockoutDate

Declaration

[IgnoreDataMember]
public DateTime? LastLockoutDate { get; set; }

Property Value

Type	Description
System.Nullable<DateTime>

LastLoginDate

Declaration

[IgnoreDataMember]
public DateTime? LastLoginDate { get; set; }

Property Value

Type	Description
System.Nullable<DateTime>

LastPasswordChangeDate

Declaration

[IgnoreDataMember]
public DateTime? LastPasswordChangeDate { get; set; }

Property Value

Type	Description
System.Nullable<DateTime>

Name

Declaration

[DataMember]
public string Name { get; set; }

Property Value

Type	Description
System.String

PasswordConfiguration

Declaration

[IgnoreDataMember]
public string PasswordConfiguration { get; set; }

Property Value

Type	Description
System.String

ProfileData

Declaration

public IProfile ProfileData { get; }

Property Value

Type	Description
IProfile

RawPasswordValue

Declaration

[IgnoreDataMember]
public string RawPasswordValue { get; set; }

Property Value

Type	Description
System.String

SecurityStamp

The security stamp used by ASP.Net identity

Declaration

[IgnoreDataMember]
public string SecurityStamp { get; set; }

Property Value

Type	Description
System.String

SessionTimeout

Gets or sets the session timeout.

Declaration

[DataMember]
public int SessionTimeout { get; set; }

Property Value

Type	Description
System.Int32	The session timeout.

StartContentIds

Gets or sets the start content id.

Declaration

[DataMember]
public int[] StartContentIds { get; set; }

Property Value

Type	Description
System.Int32[]	The start content id.

StartMediaIds

Gets or sets the start media id.

Declaration

[DataMember]
public int[] StartMediaIds { get; set; }

Property Value

Type	Description
System.Int32[]	The start media id.

Username

Declaration

[DataMember]
public string Username { get; set; }

Property Value

Type	Description
System.String

UserState

Declaration

public UserState UserState { get; }

Property Value

Type	Description
UserState

Methods

AddGroup(IReadOnlyUserGroup)

Declaration

public void AddGroup(IReadOnlyUserGroup group)

Parameters

Type	Name	Description
IReadOnlyUserGroup	group

ClearGroups()

Declaration

public void ClearGroups()

PerformDeepClone(Object)

Declaration

protected override void PerformDeepClone(object clone)

Parameters

Type	Name	Description
System.Object	clone

RemoveGroup(String)

Declaration

public void RemoveGroup(string group)

Parameters

Type	Name	Description
System.String	group