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)

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

Type Parameters

TUser

The type of the user.

inTKey

The type of the keys in the store.

NameDescription
System_CAPS_pubmethodCreateAsync(TUser)

Asynchronously inserts a new user.(Inherited from IUserStore<TUser, TKey>.)

System_CAPS_pubmethodDeleteAsync(TUser)

Asynchronously deletes a user.(Inherited from IUserStore<TUser, TKey>.)

System_CAPS_pubmethodDispose()

(Inherited from IDisposable.)

System_CAPS_pubmethodFindByIdAsync(TKey)

Asynchronously finds a user using the specified identifier.(Inherited from IUserStore<TUser, TKey>.)

System_CAPS_pubmethodFindByNameAsync(String)

Asynchronously finds a user by name.(Inherited from IUserStore<TUser, TKey>.)

System_CAPS_pubmethodGetAccessFailedCountAsync(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.

System_CAPS_pubmethodGetLockoutEnabledAsync(TUser)

Asynchronously returns whether the user can be locked out.

System_CAPS_pubmethodGetLockoutEndDateAsync(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.

System_CAPS_pubmethodIncrementAccessFailedCountAsync(TUser)

Used to record when an attempt to access the user has failed.

System_CAPS_pubmethodResetAccessFailedCountAsync(TUser)

Used to reset the access failed count, typically after the account is successfully accessed.

System_CAPS_pubmethodSetLockoutEnabledAsync(TUser, Boolean)

Asynchronously sets whether the user can be locked out.

System_CAPS_pubmethodSetLockoutEndDateAsync(TUser, DateTimeOffset)

Asynchronously locks a user out until the specified end date (set to a past date, to unlock a user).

System_CAPS_pubmethodUpdateAsync(TUser)

Asynchronously updates a user.(Inherited from IUserStore<TUser, TKey>.)

Return to top
Show: