KenticoUserStore<TUser> Class

Implements basic user management operations.

Inheritance Hierarchy

System.Object
  Kentico.Membership.ApplicationUserStore<TUser>
    Kentico.Membership.KenticoUserStore<TUser>
      Kentico.Membership.KenticoUserStore

Namespace: Kentico.Membership
Assembly: Kentico.Membership (in Kentico.Membership.dll) Version: 13.0.131

Syntax

public class KenticoUserStore<TUser> : ApplicationUserStore<TUser>, 
	IUserPasswordStore<TUser, int>, IUserStore<TUser, int>, IDisposable, 
	IUserLockoutStore<TUser, int>, IUserTwoFactorStore<TUser, int>, IUserRoleStore<TUser, int>, 
	IUserEmailStore<TUser, int>, IUserLoginStore<TUser, int>, IUserSecurityStampStore<TUser, int>
where TUser : new(), User

Type Parameters

TUser

The KenticoUserStore<TUser> type exposes the following members.

Constructors

	Name	Description
Public method	KenticoUserStore<TUser>(String)	Creates store to manage users for given site.
Public method	KenticoUserStore<TUser>(String, IUserInfoProvider, IUserRoleInfoProvider, IExternalLoginInfoProvider)	Creates store to manage users for given site.

Methods

	Name	Description
Public method	AddLoginAsync(TUser, UserLoginInfo)	Adds external login to user.
Public method	AddLoginAsync(TUser, UserLoginInfo, CancellationToken)	Adds an external UserLoginInfo to the specified user. (Inherited from ApplicationUserStore<TUser>.)
Public method	AddToRoleAsync(TUser, String)	Adds user to Role.
Public method	AddToRoleAsync(TUser, String, CancellationToken)	Add the specified user to the named role. (Inherited from ApplicationUserStore<TUser>.)
Public method	CreateAsync(TUser)	Inserts new user to the database.
Public method	CreateAsync(TUser, CancellationToken)	Creates the specified user in the user store. (Inherited from ApplicationUserStore<TUser>.)
Public method	DeleteAsync(TUser)	Deletes the user.
Public method	DeleteAsync(TUser, CancellationToken)	Deletes the user. (Inherited from ApplicationUserStore<TUser>.)
Public method	Dispose()	Performs tasks to dispose the user store. (Inherited from ApplicationUserStore<TUser>.)
Protected method	Dispose(Boolean)	Disposes the user store. (Inherited from ApplicationUserStore<TUser>.)
Public method	FindAsync	Returns user based on given external login.
Public method	FindByEmailAsync(String)	Returns the user associated with the given email.
Public method	FindByEmailAsync(String, CancellationToken)	Gets the user, if any, associated with the specified, normalized email address. (Inherited from ApplicationUserStore<TUser>.)
Public method	FindByIdAsync(Int32)	Finds the user by user's UserId.
Public method	FindByIdAsync(Int32, CancellationToken)	Finds and returns a user, if any, who has the specified userId. (Inherited from ApplicationUserStore<TUser>.)
Public method	FindByIdAsync(String, CancellationToken)	Finds and returns a user, if any, who has the specified userId. (Inherited from ApplicationUserStore<TUser>.)
Public method	FindByLoginAsync	Retrieves the user associated with the specified login provider and login provider key. (Inherited from ApplicationUserStore<TUser>.)
Public method	FindByNameAsync(String)	Finds the user by user's username.
Public method	FindByNameAsync(String, CancellationToken)	Finds and returns a user, if any, who has the specified normalized user name. (Inherited from ApplicationUserStore<TUser>.)
Public method	GetAccessFailedCountAsync	Returns the current number of failed access attempts.
Public method	GetEmailAsync(TUser)	Gets the user email.
Public method	GetEmailAsync(TUser, CancellationToken)	Gets the email address for the specified user. (Inherited from ApplicationUserStore<TUser>.)
Public method	GetEmailConfirmedAsync(TUser)	Returns true if the user email is confirmed.
Public method	GetEmailConfirmedAsync(TUser, CancellationToken)	Gets a flag indicating whether the email address for the specified user has been verified, true if the email address is verified otherwise false. (Inherited from ApplicationUserStore<TUser>.)
Public method	GetLockoutEnabledAsync	Returns whether the user can be locked out.
Public method	GetLockoutEndDateAsync	Returns the DateTimeOffset that represents the end of the user's lockout, any time in the past should be considered not locked out.
Public method	GetLoginsAsync(TUser)	Returns all external logins of user.
Public method	GetLoginsAsync(TUser, CancellationToken)	Retrieves the associated logins for the specified . (Inherited from ApplicationUserStore<TUser>.)
Public method	GetNormalizedEmailAsync	Returns the normalized email for the specified user. (Inherited from ApplicationUserStore<TUser>.)
Public method	GetNormalizedUserNameAsync	Gets the normalized user name for the specified user. (Inherited from ApplicationUserStore<TUser>.)
Public method	GetPasswordHashAsync(TUser)	Gets the password hash for the user.
Public method	GetPasswordHashAsync(TUser, CancellationToken)	Gets the password hash for the specified user. (Inherited from ApplicationUserStore<TUser>.)
Public method	GetRolesAsync(TUser)	Returns all role names for the given user.
Public method	GetRolesAsync(TUser, CancellationToken)	Gets a list of role names the specified user belongs to. (Inherited from ApplicationUserStore<TUser>.)
Public method	GetSecurityStampAsync(TUser)	Returns user's security stamp.
Public method	GetSecurityStampAsync(TUser, CancellationToken)	Get the security stamp for the specified user. (Inherited from ApplicationUserStore<TUser>.)
Public method	GetTwoFactorEnabledAsync	Returns whether two factor authentication is enabled for the user.
Public method	GetUserIdAsync	Gets the user identifier for the specified user. (Inherited from ApplicationUserStore<TUser>.)
Public method	GetUserNameAsync	Gets the user name for the specified user. (Inherited from ApplicationUserStore<TUser>.)
Public method	GetUsersInRoleAsync	Returns a list of Users who are members of the named role. (Inherited from ApplicationUserStore<TUser>.)
Public method	HasPasswordAsync(TUser)	Returns true if the user has the password set.
Public method	HasPasswordAsync(TUser, CancellationToken)	Gets a flag indicating whether the specified user has a password. (Inherited from ApplicationUserStore<TUser>.)
Public method	IncrementAccessFailedCountAsync	Obsolete. Used to record when an attempt to access the user has failed.
Public method	IsInRoleAsync(TUser, String)	Checks whether user is in role with given role name.
Public method	IsInRoleAsync(TUser, String, CancellationToken)	Returns a flag indicating whether the specified user is a member of the given named role. (Inherited from ApplicationUserStore<TUser>.)
Public method	RemoveFromRoleAsync(TUser, String)	Removes user from Role.
Public method	RemoveFromRoleAsync(TUser, String, CancellationToken)	Remove the specified user from the named role. (Inherited from ApplicationUserStore<TUser>.)
Public method	RemoveLoginAsync(TUser, UserLoginInfo)	Removes external login to user.
Public method	RemoveLoginAsync(TUser, String, String, CancellationToken)	Attempts to remove the provided login information from the specified user. and returns a flag indicating whether the removal succeed or not. (Inherited from ApplicationUserStore<TUser>.)
Public method	ResetAccessFailedCountAsync	Obsolete. Used to reset the access failed count, typically after the account is successfully accessed.
Public method	SetEmailAsync(TUser, String)	Sets the user email.
Public method	SetEmailAsync(TUser, String, CancellationToken)	Sets the email address for a user. (Inherited from ApplicationUserStore<TUser>.)
Public method	SetEmailConfirmedAsync(TUser, Boolean)	Enables user if her email was confirmed.
Public method	SetEmailConfirmedAsync(TUser, Boolean, CancellationToken)	Sets the flag indicating whether the specified user's email address has been confirmed or not. (Inherited from ApplicationUserStore<TUser>.)
Public method	SetLockoutEnabledAsync	Obsolete. Sets whether the user can be locked out.
Public method	SetLockoutEndDateAsync	Obsolete. Locks a user out until the specified end date (set to a past date, to unlock a user).
Public method	SetNormalizedEmailAsync	Sets the normalized email for the specified user. (Inherited from ApplicationUserStore<TUser>.)
Public method	SetNormalizedUserNameAsync	Sets the given normalized name for the specified user. (Inherited from ApplicationUserStore<TUser>.)
Public method	SetPasswordHashAsync(TUser, String)	Sets the password hash for the user.
Public method	SetPasswordHashAsync(TUser, String, CancellationToken)	Sets the password hash for the specified user. (Inherited from ApplicationUserStore<TUser>.)
Public method	SetSecurityStampAsync(TUser, String)	Sets user's security stamp.
Public method	SetSecurityStampAsync(TUser, String, CancellationToken)	Sets the provided security stamp for the specified user. (Inherited from ApplicationUserStore<TUser>.)
Public method	SetTwoFactorEnabledAsync	Obsolete. Sets whether two factor authentication is enabled for the user.
Public method	SetUserNameAsync	Sets the given userName for the specified user. (Inherited from ApplicationUserStore<TUser>.)
Protected method	ThrowIfDisposed	Throws if this class has been disposed. (Inherited from ApplicationUserStore<TUser>.)
Public method	UpdateAsync(TUser)	Updates a user.
Public method	UpdateAsync(TUser, CancellationToken)	Updates the specified user in the user store. (Inherited from ApplicationUserStore<TUser>.)