UserStore Class

Implements basic user management operations.

Inheritance Hierarchy

System.Object
  Kentico.Membership.UserStore

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

Syntax

public class UserStore : IUserPasswordStore<User, int>, 
	IUserStore<User, int>, IDisposable, IUserLockoutStore<User, int>, 
	IUserTwoFactorStore<User, int>, IUserRoleStore<User, int>, 
	IUserEmailStore<User, int>, IUserLoginStore<User, int>, 
	IUserSecurityStampStore<User, int>

The UserStore type exposes the following members.

Constructors

	Name	Description
Public method	UserStore	Creates store to manage users for given site.

Methods

	Name	Description
Public method	AddLoginAsync	Adds external login to user.
Public method	AddToRoleAsync	Adds User to Role.
Public method	CreateAsync	Inserts new user to the database.
Public method	DeleteAsync	Deletes the user.
Public method	Dispose()	Performs tasks to dispose the user store.
Protected method	Dispose(Boolean)	Disposes the user store.
Public method	FindAsync	Returns user based on given external login.
Public method	FindByEmailAsync	Returns the user associated with the given email.
Public method	FindByIdAsync	Finds the user by user's ID.
Public method	FindByNameAsync	Finds the user by user's username.
Public method	GetAccessFailedCountAsync	Returns the current number of failed access attempts.
Public method	GetEmailAsync	Gets the user email.
Public method	GetEmailConfirmedAsync	Returns true if the user email is confirmed.
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	Returns all external logins of user.
Public method	GetPasswordHashAsync	Gets the password hash for the user.
Public method	GetRolesAsync	Returns all role names for the given user.
Public method	GetSecurityStampAsync	Returns user's security stamp.
Public method	GetTwoFactorEnabledAsync	Returns whether two factor authentication is enabled for the user.
Public method	HasPasswordAsync	Returns true if the user has the password set.
Public method	IncrementAccessFailedCountAsync	Used to record when an attempt to access the user has failed.
Public method	IsInRoleAsync	Checks whether user is in role with given role name.
Public method	RemoveFromRoleAsync	Removes User from Role.
Public method	RemoveLoginAsync	Removes external login to user.
Public method	ResetAccessFailedCountAsync	Used to reset the access failed count, typically after the account is successfully accessed.
Public method	SetEmailAsync	Sets the user email.
Public method	SetEmailConfirmedAsync	Enables user if her email was confirmed.
Public method	SetLockoutEnabledAsync	Sets whether the user can be locked out.
Public method	SetLockoutEndDateAsync	Locks a user out until the specified end date (set to a past date, to unlock a user).
Public method	SetPasswordHashAsync	Sets the password hash for the user.
Public method	SetSecurityStampAsync	Sets user's security stamp.
Public method	SetTwoFactorEnabledAsync	Sets whether two factor authentication is enabled for the user.
Public method	UpdateAsync	Updates a user.