Try our conversational search powered by Generative AI!

Class UIUserProvider

Inheritance
System.Object
UIUserProvider
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Shell.Security
Assembly: EPiServer.Shell.dll
Version: 11.20.7
Syntax
public abstract class UIUserProvider : IDisposable

Constructors

UIUserProvider()

Declaration
protected UIUserProvider()

Properties

Enabled

Declaration
public abstract bool Enabled { get; }
Property Value
Type Description
System.Boolean

EnablePasswordReset

Declaration
public virtual bool EnablePasswordReset { get; }
Property Value
Type Description
System.Boolean

MinRequiredNonAlphanumericCharacters

Declaration
public virtual int MinRequiredNonAlphanumericCharacters { get; }
Property Value
Type Description
System.Int32

MinRequiredPasswordLength

Declaration
public virtual int MinRequiredPasswordLength { get; }
Property Value
Type Description
System.Int32

Name

Declaration
public abstract string Name { get; }
Property Value
Type Description
System.String

RequiresQuestionAndAnswer

Declaration
public virtual bool RequiresQuestionAndAnswer { get; }
Property Value
Type Description
System.Boolean

RequiresUniqueEmail

Declaration
public virtual bool RequiresUniqueEmail { get; }
Property Value
Type Description
System.Boolean

Methods

CreateUser(String, String, String, String, String, Boolean, out UIUserCreateStatus, out IEnumerable<String>)

Declaration
public abstract IUIUser CreateUser(string username, string password, string email, string passwordQuestion, string passwordAnswer, bool isApproved, out UIUserCreateStatus status, out IEnumerable<string> errors)
Parameters
Type Name Description
System.String username
System.String password
System.String email
System.String passwordQuestion
System.String passwordAnswer
System.Boolean isApproved
UIUserCreateStatus status
System.Collections.Generic.IEnumerable<System.String> errors
Returns
Type Description
IUIUser

DeleteUser(String, Boolean)

Declaration
public abstract bool DeleteUser(string username, bool deleteAllRelatedData)
Parameters
Type Name Description
System.String username
System.Boolean deleteAllRelatedData
Returns
Type Description
System.Boolean

DeleteUser(String, String, Boolean)

Declaration
public virtual bool DeleteUser(string providerName, string username, bool deleteAllRelatedData)
Parameters
Type Name Description
System.String providerName
System.String username
System.Boolean deleteAllRelatedData
Returns
Type Description
System.Boolean

Dispose()

Declaration
public void Dispose()

Dispose(Boolean)

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

FindUsersByEmail(String, Int32, Int32, out Int32)

Declaration
public abstract IEnumerable<IUIUser> FindUsersByEmail(string emailToMatch, int pageIndex, int pageSize, out int totalRecords)
Parameters
Type Name Description
System.String emailToMatch
System.Int32 pageIndex
System.Int32 pageSize
System.Int32 totalRecords
Returns
Type Description
System.Collections.Generic.IEnumerable<IUIUser>

FindUsersByName(String, Int32, Int32, out Int32)

Declaration
public abstract IEnumerable<IUIUser> FindUsersByName(string usernameToMatch, int pageIndex, int pageSize, out int totalRecords)
Parameters
Type Name Description
System.String usernameToMatch
System.Int32 pageIndex
System.Int32 pageSize
System.Int32 totalRecords
Returns
Type Description
System.Collections.Generic.IEnumerable<IUIUser>

GetAllUsers(Int32, Int32, out Int32)

Declaration
public abstract IEnumerable<IUIUser> GetAllUsers(int pageIndex, int pageSize, out int totalRecords)
Parameters
Type Name Description
System.Int32 pageIndex
System.Int32 pageSize
System.Int32 totalRecords
Returns
Type Description
System.Collections.Generic.IEnumerable<IUIUser>

GetUser(String)

Declaration
public abstract IUIUser GetUser(string username)
Parameters
Type Name Description
System.String username
Returns
Type Description
IUIUser

GetUserComparer()

Declaration
public virtual IEqualityComparer<IUIUser> GetUserComparer()
Returns
Type Description
System.Collections.Generic.IEqualityComparer<IUIUser>

GetWildcardSymbolFromDefaultProvider()

Declaration
public virtual string GetWildcardSymbolFromDefaultProvider()
Returns
Type Description
System.String

IsSupported(ProviderActions)

Declaration
public virtual bool IsSupported(ProviderActions action)
Parameters
Type Name Description
ProviderActions action
Returns
Type Description
System.Boolean

IsSupported(String)

Declaration
public virtual bool IsSupported(string propertyName)
Parameters
Type Name Description
System.String propertyName
Returns
Type Description
System.Boolean

IsSupported(String, ProviderActions)

Declaration
public virtual bool IsSupported(string providerName, ProviderActions action)
Parameters
Type Name Description
System.String providerName
ProviderActions action
Returns
Type Description
System.Boolean

IsSupported(String, String)

Declaration
public virtual bool IsSupported(string providerName, string propertyName)
Parameters
Type Name Description
System.String providerName
System.String propertyName
Returns
Type Description
System.Boolean

UpdateUser(IUIUser)

Declaration
[Obsolete("Use the UpdateUser method thar returns the errors")]
public abstract void UpdateUser(IUIUser user)
Parameters
Type Name Description
IUIUser user

UpdateUser(IUIUser, out IEnumerable<String>)

Declaration
public virtual bool UpdateUser(IUIUser user, out IEnumerable<string> errors)
Parameters
Type Name Description
IUIUser user
System.Collections.Generic.IEnumerable<System.String> errors
Returns
Type Description
System.Boolean

Implements

System.IDisposable

Extension Methods