Class MembershipProvider

Inheritance

object

MembershipProvider

AspNetMembershipProvider

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DotNetNuke.Security.Membership

Assembly: DotNetNuke.dll

Syntax

public abstract class MembershipProvider

Constructors

MembershipProvider()

Declaration

protected MembershipProvider()

Properties

CanEditProviderProperties

Declaration

public abstract bool CanEditProviderProperties { get; }

Property Value

Type	Description
bool

MaxInvalidPasswordAttempts

Declaration

public abstract int MaxInvalidPasswordAttempts { get; set; }

Property Value

Type	Description
int

MinNonAlphanumericCharacters

Declaration

public abstract int MinNonAlphanumericCharacters { get; set; }

Property Value

Type	Description
int

MinPasswordLength

Declaration

public abstract int MinPasswordLength { get; set; }

Property Value

Type	Description
int

PasswordAttemptWindow

Declaration

public abstract int PasswordAttemptWindow { get; set; }

Property Value

Type	Description
int

PasswordFormat

Declaration

public abstract PasswordFormat PasswordFormat { get; set; }

Property Value

Type	Description
PasswordFormat

PasswordResetEnabled

Declaration

public abstract bool PasswordResetEnabled { get; set; }

Property Value

Type	Description
bool

PasswordRetrievalEnabled

Declaration

public abstract bool PasswordRetrievalEnabled { get; set; }

Property Value

Type	Description
bool

PasswordStrengthRegularExpression

Declaration

public abstract string PasswordStrengthRegularExpression { get; set; }

Property Value

Type	Description
string

RequiresQuestionAndAnswer

Declaration

public abstract bool RequiresQuestionAndAnswer { get; set; }

Property Value

Type	Description
bool

RequiresUniqueEmail

Declaration

public abstract bool RequiresUniqueEmail { get; set; }

Property Value

Type	Description
bool

Methods

AddUserPortal(int, int)

Declaration

public virtual void AddUserPortal(int portalId, int userId)

Parameters

Type	Name	Description
int	portalId
int	userId

ChangePassword(UserInfo, string, string)

Declaration

public abstract bool ChangePassword(UserInfo user, string oldPassword, string newPassword)

Parameters

Type	Name	Description
UserInfo	user
string	oldPassword
string	newPassword

Returns

Type	Description
bool

ChangePasswordQuestionAndAnswer(UserInfo, string, string, string)

Declaration

public abstract bool ChangePasswordQuestionAndAnswer(UserInfo user, string password, string passwordQuestion, string passwordAnswer)

Parameters

Type	Name	Description
UserInfo	user
string	password
string	passwordQuestion
string	passwordAnswer

Returns

Type	Description
bool

ChangeUsername(int, string)

Declaration

public virtual void ChangeUsername(int userId, string newUsername)

Parameters

Type	Name	Description
int	userId
string	newUsername

CreateUser(ref UserInfo)

Declaration

public abstract UserCreateStatus CreateUser(ref UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
UserCreateStatus

DeleteUser(UserInfo)

Declaration

public abstract bool DeleteUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
bool

DeleteUsersOnline(int)

Declaration

[Obsolete("Deprecated in DotNetNuke 8.0.0. Other solutions exist outside of the DNN Platform. Scheduled for removal in v11.0.0.")]
public abstract void DeleteUsersOnline(int timeWindow)

Parameters

Type	Name	Description
int	timeWindow

GeneratePassword()

Declaration

public abstract string GeneratePassword()

Returns

Type	Description
string

GeneratePassword(int)

Declaration

public abstract string GeneratePassword(int length)

Parameters

Type	Name	Description
int	length

Returns

Type	Description
string

GetDeletedUsers(int)

Declaration

public abstract ArrayList GetDeletedUsers(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
ArrayList

GetOnlineUsers(int)

Declaration

[Obsolete("Deprecated in DotNetNuke 8.0.0. Other solutions exist outside of the DNN Platform. Scheduled for removal in v11.0.0.")]
public abstract ArrayList GetOnlineUsers(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
ArrayList

GetPassword(UserInfo, string)

Declaration

public abstract string GetPassword(UserInfo user, string passwordAnswer)

Parameters

Type	Name	Description
UserInfo	user
string	passwordAnswer

Returns

Type	Description
string

GetProviderUserKey(UserInfo)

Declaration

public virtual string GetProviderUserKey(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
string

GetUnAuthorizedUsers(int)

Declaration

public abstract ArrayList GetUnAuthorizedUsers(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
ArrayList

GetUnAuthorizedUsers(int, bool, bool)

Declaration

public virtual ArrayList GetUnAuthorizedUsers(int portalId, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
int	portalId
bool	includeDeleted
bool	superUsersOnly

Returns

Type	Description
ArrayList

GetUser(int, int)

Declaration

public abstract UserInfo GetUser(int portalId, int userId)

Parameters

Type	Name	Description
int	portalId
int	userId

Returns

Type	Description
UserInfo

GetUserByAuthToken(int, string, string)

Declaration

public virtual UserInfo GetUserByAuthToken(int portalId, string userToken, string authType)

Parameters

Type	Name	Description
int	portalId
string	userToken
string	authType

Returns

Type	Description
UserInfo

GetUserByDisplayName(int, string)

Declaration

public virtual UserInfo GetUserByDisplayName(int portalId, string displayName)

Parameters

Type	Name	Description
int	portalId
string	displayName

Returns

Type	Description
UserInfo

GetUserByPasswordResetToken(int, string)

Declaration

public virtual UserInfo GetUserByPasswordResetToken(int portalId, string resetToken)

Parameters

Type	Name	Description
int	portalId
string	resetToken

Returns

Type	Description
UserInfo

GetUserByProviderUserKey(int, string)

Declaration

public virtual UserInfo GetUserByProviderUserKey(int portalId, string providerUserKey)

Parameters

Type	Name	Description
int	portalId
string	providerUserKey

Returns

Type	Description
UserInfo

GetUserByUserName(int, string)

Declaration

public abstract UserInfo GetUserByUserName(int portalId, string username)

Parameters

Type	Name	Description
int	portalId
string	username

Returns

Type	Description
UserInfo

GetUserByVanityUrl(int, string)

Declaration

public virtual UserInfo GetUserByVanityUrl(int portalId, string vanityUrl)

Parameters

Type	Name	Description
int	portalId
string	vanityUrl

Returns

Type	Description
UserInfo

GetUserCountByPortal(int)

Declaration

public abstract int GetUserCountByPortal(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
int

GetUserMembership(ref UserInfo)

Declaration

public abstract void GetUserMembership(ref UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

GetUsers(int, int, int, ref int)

Declaration

public abstract ArrayList GetUsers(int portalId, int pageIndex, int pageSize, ref int totalRecords)

Parameters

Type	Name	Description
int	portalId
int	pageIndex
int	pageSize
int	totalRecords

Returns

Type	Description
ArrayList

GetUsers(int, int, int, ref int, bool, bool)

Declaration

public virtual ArrayList GetUsers(int portalId, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
int	portalId
int	pageIndex
int	pageSize
int	totalRecords
bool	includeDeleted
bool	superUsersOnly

Returns

Type	Description
ArrayList

GetUsersAdvancedSearch(int, int, int, int, int, bool, int, int, string, bool, string, string)

Declaration

public virtual IList<UserInfo> GetUsersAdvancedSearch(int portalId, int userId, int filterUserId, int filterRoleId, int relationTypeId, bool isAdmin, int pageIndex, int pageSize, string sortColumn, bool sortAscending, string propertyNames, string propertyValues)

Parameters

Type	Name	Description
int	portalId
int	userId
int	filterUserId
int	filterRoleId
int	relationTypeId
bool	isAdmin
int	pageIndex
int	pageSize
string	sortColumn
bool	sortAscending
string	propertyNames
string	propertyValues

Returns

Type	Description
IList<UserInfo>

GetUsersBasicSearch(int, int, int, string, bool, string, string)

Declaration

public virtual IList<UserInfo> GetUsersBasicSearch(int portalId, int pageIndex, int pageSize, string sortColumn, bool sortAscending, string propertyName, string propertyValue)

Parameters

Type	Name	Description
int	portalId
int	pageIndex
int	pageSize
string	sortColumn
bool	sortAscending
string	propertyName
string	propertyValue

Returns

Type	Description
IList<UserInfo>

GetUsersByDisplayName(int, string, int, int, ref int, bool, bool)

Declaration

public virtual ArrayList GetUsersByDisplayName(int portalId, string nameToMatch, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
int	portalId
string	nameToMatch
int	pageIndex
int	pageSize
int	totalRecords
bool	includeDeleted
bool	superUsersOnly

Returns

Type	Description
ArrayList

GetUsersByEmail(int, string, int, int, ref int)

Declaration

public abstract ArrayList GetUsersByEmail(int portalId, string emailToMatch, int pageIndex, int pageSize, ref int totalRecords)

Parameters

Type	Name	Description
int	portalId
string	emailToMatch
int	pageIndex
int	pageSize
int	totalRecords

Returns

Type	Description
ArrayList

GetUsersByEmail(int, string, int, int, ref int, bool, bool)

Declaration

public virtual ArrayList GetUsersByEmail(int portalId, string emailToMatch, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
int	portalId
string	emailToMatch
int	pageIndex
int	pageSize
int	totalRecords
bool	includeDeleted
bool	superUsersOnly

Returns

Type	Description
ArrayList

GetUsersByProfileProperty(int, string, string, int, int, ref int)

Declaration

public abstract ArrayList GetUsersByProfileProperty(int portalId, string propertyName, string propertyValue, int pageIndex, int pageSize, ref int totalRecords)

Parameters

Type	Name	Description
int	portalId
string	propertyName
string	propertyValue
int	pageIndex
int	pageSize
int	totalRecords

Returns

Type	Description
ArrayList

GetUsersByProfileProperty(int, string, string, int, int, ref int, bool, bool)

Declaration

public virtual ArrayList GetUsersByProfileProperty(int portalId, string propertyName, string propertyValue, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
int	portalId
string	propertyName
string	propertyValue
int	pageIndex
int	pageSize
int	totalRecords
bool	includeDeleted
bool	superUsersOnly

Returns

Type	Description
ArrayList

GetUsersByUserName(int, string, int, int, ref int)

Declaration

public abstract ArrayList GetUsersByUserName(int portalId, string userNameToMatch, int pageIndex, int pageSize, ref int totalRecords)

Parameters

Type	Name	Description
int	portalId
string	userNameToMatch
int	pageIndex
int	pageSize
int	totalRecords

Returns

Type	Description
ArrayList

GetUsersByUserName(int, string, int, int, ref int, bool, bool)

Declaration

public virtual ArrayList GetUsersByUserName(int portalId, string userNameToMatch, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
int	portalId
string	userNameToMatch
int	pageIndex
int	pageSize
int	totalRecords
bool	includeDeleted
bool	superUsersOnly

Returns

Type	Description
ArrayList

Instance()

Declaration

public static MembershipProvider Instance()

Returns

Type	Description
MembershipProvider

IsUserOnline(UserInfo)

Declaration

[Obsolete("Deprecated in DotNetNuke 8.0.0. Other solutions exist outside of the DNN Platform. Scheduled for removal in v11.0.0.")]
public abstract bool IsUserOnline(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
bool

RemoveUser(UserInfo)

Declaration

public abstract bool RemoveUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
bool

ResetAndChangePassword(UserInfo, string)

Declaration

public virtual bool ResetAndChangePassword(UserInfo user, string newPassword)

Parameters

Type	Name	Description
UserInfo	user
string	newPassword

Returns

Type	Description
bool

ResetAndChangePassword(UserInfo, string, string)

Declaration

public virtual bool ResetAndChangePassword(UserInfo user, string newPassword, string answer)

Parameters

Type	Name	Description
UserInfo	user
string	newPassword
string	answer

Returns

Type	Description
bool

ResetPassword(UserInfo, string)

Declaration

public abstract string ResetPassword(UserInfo user, string passwordAnswer)

Parameters

Type	Name	Description
UserInfo	user
string	passwordAnswer

Returns

Type	Description
string

ResetTermsAgreement(int)

Declaration

public abstract void ResetTermsAgreement(int portalId)

Parameters

Type	Name	Description
int	portalId

RestoreUser(UserInfo)

Declaration

public abstract bool RestoreUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
bool

TransferUsersToMembershipProvider()

Declaration

public virtual void TransferUsersToMembershipProvider()

UnLockUser(UserInfo)

Declaration

public abstract bool UnLockUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
bool

UpdateUser(UserInfo)

Declaration

public abstract void UpdateUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

UpdateUsersOnline(Hashtable)

Declaration

[Obsolete("Deprecated in DotNetNuke 8.0.0. Other solutions exist outside of the DNN Platform. Scheduled for removal in v11.0.0.")]
public abstract void UpdateUsersOnline(Hashtable userList)

Parameters

Type	Name	Description
Hashtable	userList

UserAgreedToTerms(UserInfo)

Declaration

public abstract void UserAgreedToTerms(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

UserLogin(int, string, string, string, ref UserLoginStatus)

Declaration

public abstract UserInfo UserLogin(int portalId, string username, string password, string verificationCode, ref UserLoginStatus loginStatus)

Parameters

Type	Name	Description
int	portalId
string	username
string	password
string	verificationCode
UserLoginStatus	loginStatus

Returns

Type	Description
UserInfo

UserLogin(int, string, string, string, string, ref UserLoginStatus)

Declaration

public abstract UserInfo UserLogin(int portalId, string username, string password, string authType, string verificationCode, ref UserLoginStatus loginStatus)

Parameters

Type	Name	Description
int	portalId
string	username
string	password
string	authType
string	verificationCode
UserLoginStatus	loginStatus

Returns

Type	Description
UserInfo

UserRequestsRemoval(UserInfo, bool)

Declaration

public abstract void UserRequestsRemoval(UserInfo user, bool remove)

Parameters

Type	Name	Description
UserInfo	user
bool	remove

Extension Methods

JsonExtensionsWeb.ToJson(object)