View Source

Class Member

Represents a Member object

Inheritance

System.Object

BeingDirtyBase

EntityBase

TreeEntityBase

ContentBase

Namespace: Umbraco.Core.Models

Assembly: Umbraco.Core.dll

Syntax

[Serializable]
[DataContract(IsReference = true)]
public class Member : ContentBase, IMember, IContentBase, IUmbracoEntity, ITreeEntity, IRememberBeingDirty, ICanBeDirty, IMembershipUser, IEntity, IDeepCloneable, IHaveAdditionalData

Constructors

Member(String, String, String, String, IMemberType)

Constructor for creating a Member object

Declaration

public Member(string name, string email, string username, string rawPasswordValue, IMemberType contentType)

Parameters

Type	Name	Description
System.String	name
System.String	email
System.String	username
System.String	rawPasswordValue	The password value passed in to this parameter should be the encoded/encrypted/hashed format of the member's password
IMemberType	contentType

Member(String, String, String, String, IMemberType, Boolean)

Constructor for creating a Member object

Declaration

public Member(string name, string email, string username, string rawPasswordValue, IMemberType contentType, bool isApproved)

Parameters

Type	Name	Description
System.String	name
System.String	email
System.String	username
System.String	rawPasswordValue	The password value passed in to this parameter should be the encoded/encrypted/hashed format of the member's password
IMemberType	contentType
System.Boolean	isApproved

Member(String, String, String, IMemberType, Boolean)

Constructor for creating a Member object

Declaration

public Member(string name, string email, string username, IMemberType contentType, bool isApproved = true)

Parameters

Type	Name	Description
System.String	name
System.String	email
System.String	username
IMemberType	contentType
System.Boolean	isApproved

Member(String, IMemberType)

Constructor for creating a Member object

Declaration

public Member(string name, IMemberType contentType)

Parameters

Type	Name	Description
System.String	name	Name of the content
IMemberType	contentType	ContentType for the current Content object

Member(IMemberType)

Constructor for creating an empty Member object

Declaration

public Member(IMemberType contentType)

Parameters

Type	Name	Description
IMemberType	contentType	ContentType for the current Content object

Properties

AdditionalData

Gets additional data for this entity.

Declaration

[DataMember]
public IDictionary<string, object> AdditionalData { get; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

Remarks

Can be empty, but never null. To avoid allocating, do not test for emptiness, but use HasAdditionalData instead.

Comments

Gets or set the comments for the member

Declaration

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

Property Value

Type	Description
System.String

Remarks

Alias: umbracoMemberComments Part of the standard properties collection.

ContentTypeAlias

String alias of the default ContentType

Declaration

[DataMember]
public virtual string ContentTypeAlias { get; }

Property Value

Type	Description
System.String

Email

Gets or sets the Email

Declaration

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

Property Value

Type	Description
System.String

FailedPasswordAttempts

Gets or sets the number of failed password attempts. This is the number of times the password was entered incorrectly upon login.

Declaration

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

Property Value

Type	Description
System.Int32

Remarks

Alias: umbracoMemberFailedPasswordAttempts Part of the standard properties collection.

Groups

Gets or sets the Groups that Member is part of

Declaration

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

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.String>

HasAdditionalData

Determines whether this entity has additional data.

Declaration

[IgnoreDataMember]
public bool HasAdditionalData { get; }

Property Value

Type	Description
System.Boolean

Remarks

Use this property to check for additional data without getting AdditionalData, to avoid allocating.

IsApproved

Gets or sets a boolean indicating whether the Member is approved

Declaration

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

Property Value

Type	Description
System.Boolean

Remarks

Alias: umbracoMemberApproved Part of the standard properties collection.

IsLockedOut

Gets or sets a boolean indicating whether the Member is locked out

Declaration

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

Property Value

Type	Description
System.Boolean

Remarks

Alias: umbracoMemberLockedOut Part of the standard properties collection.

LastLockoutDate

Gets or sets the date for when Member was locked out

Declaration

[DataMember]
public DateTime LastLockoutDate { get; set; }

Property Value

Type	Description
System.DateTime

Remarks

Alias: umbracoMemberLastLockoutDate Part of the standard properties collection.

LastLoginDate

Gets or sets the date for last login

Declaration

[DataMember]
public DateTime LastLoginDate { get; set; }

Property Value

Type	Description
System.DateTime

Remarks

Alias: umbracoMemberLastLogin Part of the standard properties collection.

LastPasswordChangeDate

Gest or sets the date for last password change

Declaration

[DataMember]
public DateTime LastPasswordChangeDate { get; set; }

Property Value

Type	Description
System.DateTime

Remarks

Alias: umbracoMemberLastPasswordChangeDate Part of the standard properties collection.

PasswordQuestion

Gets or sets the Password Question

Declaration

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

Property Value

Type	Description
System.String

Remarks

Alias: umbracoMemberPasswordRetrievalQuestion Part of the standard properties collection.

ProviderUserKey

User key from the Provider.

Declaration

[DataMember]
public virtual object ProviderUserKey { get; set; }

Property Value

Type	Description
System.Object

Remarks

When using standard umbraco provider this key will correspond to the guid UniqueId/Key. Otherwise it will the one available from the asp.net membership provider.

RawPasswordAnswerValue

Gets or sets the raw password answer value

Declaration

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

Property Value

Type	Description
System.String

Remarks

For security reasons this value should be encrypted, the encryption process is handled by the membership provider Alias: umbracoMemberPasswordRetrievalAnswer

Part of the standard properties collection.

RawPasswordValue

Gets or sets the raw password value

Declaration

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

Property Value

Type	Description
System.String

Username

Gets or sets the Username

Declaration

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

Property Value

Type	Description
System.String