IUserLockoutStore<TUser, TKey> Interface

 

Defines the methods to implement to store information about account lockout, including access failures and lockout status.

Namespace:   Microsoft.AspNet.Identity
Assembly:  Microsoft.AspNet.Identity.Core (in Microsoft.AspNet.Identity.Core.dll)

Syntax

public interface IUserLockoutStore<TUser, in TKey> : IUserStore<TUser, TKey>, 
    IDisposable
where TUser : class, IUser<TKey>

generic<typename TUser, typename TKey>
where TUser : ref class, IUser<TKey>
public interface class IUserLockoutStore : IUserStore<TUser, TKey>, 
    IDisposable

type IUserLockoutStore<'TUser, 'TKey when 'TUser : not struct and IUser<'TKey>> = 
    interface
        interface IUserStore<'TUser, 'TKey>
        interface IDisposable
    end

Public Interface IUserLockoutStore(Of TUser As { Class, IUser(Of TKey) }, In TKey)
    Inherits IUserStore(Of TUser, TKey), IDisposable

Type Parameters

• TUser
  The type of the user.

• in TKey
  The type of the keys in the store.

Methods

	Name	Description
	CreateAsync(TUser)	Asynchronously inserts a new user.(Inherited from IUserStore<TUser, TKey>.)
	DeleteAsync(TUser)	Asynchronously deletes a user.(Inherited from IUserStore<TUser, TKey>.)
	Dispose()	(Inherited from IDisposable.)
	FindByIdAsync(TKey)	Asynchronously finds a user using the specified identifier.(Inherited from IUserStore<TUser, TKey>.)
	FindByNameAsync(String)	Asynchronously finds a user by name.(Inherited from IUserStore<TUser, TKey>.)
	GetAccessFailedCountAsync(TUser)	Asynchronously returns the current number of failed access attempts. This number usually will be reset whenever the password is verified or the account is locked out.
	GetLockoutEnabledAsync(TUser)	Asynchronously returns whether the user can be locked out.
	GetLockoutEndDateAsync(TUser)	Asynchronously returns the DateTimeOffset that represents the end of a user's lockout, any time in the past should be considered not locked out.
	IncrementAccessFailedCountAsync(TUser)	Used to record when an attempt to access the user has failed.
	ResetAccessFailedCountAsync(TUser)	Used to reset the access failed count, typically after the account is successfully accessed.
	SetLockoutEnabledAsync(TUser, Boolean)	Asynchronously sets whether the user can be locked out.
	SetLockoutEndDateAsync(TUser, DateTimeOffset)	Asynchronously locks a user out until the specified end date (set to a past date, to unlock a user).
	UpdateAsync(TUser)	Asynchronously updates a user.(Inherited from IUserStore<TUser, TKey>.)

See Also

Microsoft.AspNet.Identity Namespace
ASP.NET Identity

Return to top