UserStore<TUser,TRole,TContext> Class

Definition

Namespace:

Microsoft.AspNetCore.Identity.EntityFrameworkCore

Assembly:

Microsoft.AspNetCore.Identity.EntityFrameworkCore.dll

Package:

Microsoft.AspNetCore.Identity.EntityFrameworkCore v9.0.0

Source:

UserStore.cs

Represents a new instance of a persistence store for the specified user and role types.

generic <typename TUser, typename TRole, typename TContext>
 where TUser : IdentityUser<System::String ^> where TRole : IdentityRole<System::String ^> where TContext : DbContextpublic ref class UserStore : Microsoft::AspNetCore::Identity::EntityFrameworkCore::UserStore<TUser, TRole, TContext, System::String ^>

public class UserStore<TUser,TRole,TContext> : Microsoft.AspNetCore.Identity.EntityFrameworkCore.UserStore<TUser,TRole,TContext,string> where TUser : IdentityUser<string> where TRole : IdentityRole<string> where TContext : DbContext

type UserStore<'User, 'Role, 'Context (requires 'User :> IdentityUser<string> and 'Role :> IdentityRole<string> and 'Context :> DbContext)> = class
    inherit UserStore<'User, 'Role, 'Context, string (requires 'User :> IdentityUser<string> and 'Role :> IdentityRole<string> and 'Context :> DbContext)>

Public Class UserStore(Of TUser, TRole, TContext)
Inherits UserStore(Of TUser, TRole, TContext, String)

Type Parameters

TUser

The type representing a user.

TRole

The type representing a role.

TContext

The type of the data context class used to access the store.

Inheritance

Object

UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>

UserStoreBase<TUser,TRole,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>

UserStore<TUser,TRole,TContext,TKey,IdentityUserClaim<TKey>,IdentityUserRole<TKey>,IdentityUserLogin<TKey>,IdentityUserToken<TKey>,IdentityRoleClaim<TKey>>

UserStore<TUser,TRole,TContext,String>

UserStore<TUser,TRole,TContext>

Constructors

UserStore<TUser,TRole,TContext>(TContext, IdentityErrorDescriber)

Constructs a new instance of UserStore<TUser,TRole,TContext>.

Properties

AutoSaveChanges	Gets or sets a flag indicating if changes should be persisted after CreateAsync, UpdateAsync and DeleteAsync are called. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
Context	Gets the database context for this store. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
ErrorDescriber	Gets or sets the IdentityErrorDescriber for any error that occurred with the current operation. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
Users	A navigation property for the users the store contains. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)

Methods

AddClaimsAsync(TUser, IEnumerable<Claim>, CancellationToken)	Adds the claims given to the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
AddLoginAsync(TUser, UserLoginInfo, CancellationToken)	Adds the login given to the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
AddToRoleAsync(TUser, String, CancellationToken)	Adds the given normalizedRoleName to the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
AddUserTokenAsync(TUserToken)	Add a new user token. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
AddUserTokenAsync(TUserToken)	Add a new user token. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
ConvertIdFromString(String)	Converts the provided id to a strongly typed key object. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
ConvertIdToString(TKey)	Converts the provided id to its string representation. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
ConvertIdToString(TKey)	Converts the provided id to its string representation. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
CountCodesAsync(TUser, CancellationToken)	Returns how many recovery code are still valid for a user. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
CreateAsync(TUser, CancellationToken)	Creates the specified user in the user store. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
CreateUserClaim(TUser, Claim)	Called to create a new instance of a IdentityUserClaim<TKey>. (Inherited from UserStore<TUser,TRole,TContext,TKey>)
CreateUserLogin(TUser, UserLoginInfo)	Called to create a new instance of a IdentityUserLogin<TKey>. (Inherited from UserStore<TUser,TRole,TContext,TKey>)
CreateUserRole(TUser, TRole)	Called to create a new instance of a IdentityUserRole<TKey>. (Inherited from UserStore<TUser,TRole,TContext,TKey>)
CreateUserToken(TUser, String, String, String)	Called to create a new instance of a IdentityUserToken<TKey>. (Inherited from UserStore<TUser,TRole,TContext,TKey>)
DeleteAsync(TUser, CancellationToken)	Deletes the specified user from the user store. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
Dispose()	Dispose the store (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
FindByEmailAsync(String, CancellationToken)	Gets the user, if any, associated with the specified, normalized email address. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
FindByIdAsync(String, CancellationToken)	Finds and returns a user, if any, who has the specified userId. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
FindByLoginAsync(String, String, CancellationToken)	Retrieves the user associated with the specified login provider and login provider key. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
FindByNameAsync(String, CancellationToken)	Finds and returns a user, if any, who has the specified normalized user name. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
FindRoleAsync(String, CancellationToken)	Return a role with the normalized name if it exists. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
FindTokenAsync(TUser, String, String, CancellationToken)	Find a user token if it exists. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
FindUserAsync(TKey, CancellationToken)	Return a user with the matching userId if it exists. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
FindUserAsync(TKey, CancellationToken)	Return a user with the matching userId if it exists. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
FindUserLoginAsync(String, String, CancellationToken)	Return a user login with provider, providerKey if it exists. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
FindUserLoginAsync(TKey, String, String, CancellationToken)	Return a user login with the matching userId, provider, providerKey if it exists. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
FindUserLoginAsync(TKey, String, String, CancellationToken)	Return a user login with the matching userId, provider, providerKey if it exists. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
FindUserRoleAsync(TKey, TKey, CancellationToken)	Return a user role for the userId and roleId if it exists. (Inherited from UserStoreBase<TUser,TRole,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
FindUserRoleAsync(TKey, TKey, CancellationToken)	Return a user role for the userId and roleId if it exists. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetAccessFailedCountAsync(TUser, CancellationToken)	Retrieves the current failed access count for the specified user.. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetAuthenticatorKeyAsync(TUser, CancellationToken)	Get the authenticator key for the specified user. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetClaimsAsync(TUser, CancellationToken)	Get the claims associated with the specified user as an asynchronous operation. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetEmailAsync(TUser, CancellationToken)	Gets the email address for the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
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 UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetLockoutEnabledAsync(TUser, CancellationToken)	Retrieves a flag indicating whether user lockout can enabled for the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetLockoutEndDateAsync(TUser, CancellationToken)	Gets the last DateTimeOffset a user's last lockout expired, if any. Any time in the past should be indicates a user is not locked out. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetLoginsAsync(TUser, CancellationToken)	Retrieves the associated logins for the specified . (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetNormalizedEmailAsync(TUser, CancellationToken)	Returns the normalized email for the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetNormalizedUserNameAsync(TUser, CancellationToken)	Gets the normalized user name for the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetPasswordHashAsync(TUser, CancellationToken)	Gets the password hash for a user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetPhoneNumberAsync(TUser, CancellationToken)	Gets the telephone number, if any, for the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetPhoneNumberConfirmedAsync(TUser, CancellationToken)	Gets a flag indicating whether the specified user's telephone number has been confirmed. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetRolesAsync(TUser, CancellationToken)	Retrieves the roles the specified user is a member of. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetSecurityStampAsync(TUser, CancellationToken)	Get the security stamp for the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetTokenAsync(TUser, String, String, CancellationToken)	Returns the token value. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetTwoFactorEnabledAsync(TUser, CancellationToken)	Returns a flag indicating whether the specified user has two factor authentication enabled or not, as an asynchronous operation. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetUserIdAsync(TUser, CancellationToken)	Gets the user identifier for the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetUserNameAsync(TUser, CancellationToken)	Gets the user name for the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetUsersForClaimAsync(Claim, CancellationToken)	Retrieves all users with the specified claim. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetUsersInRoleAsync(String, CancellationToken)	Retrieves all users in the specified role. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
HasPasswordAsync(TUser, CancellationToken)	Returns a flag indicating if the specified user has a password. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
IncrementAccessFailedCountAsync(TUser, CancellationToken)	Records that a failed access has occurred, incrementing the failed access count. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
IsInRoleAsync(TUser, String, CancellationToken)	Returns a flag indicating if the specified user is a member of the give normalizedRoleName. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
RedeemCodeAsync(TUser, String, CancellationToken)	Returns whether a recovery code is valid for a user. Note: recovery codes are only valid once, and will be invalid after use. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
RemoveClaimsAsync(TUser, IEnumerable<Claim>, CancellationToken)	Removes the claims given from the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
RemoveFromRoleAsync(TUser, String, CancellationToken)	Removes the given normalizedRoleName from the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
RemoveLoginAsync(TUser, String, String, CancellationToken)	Removes the loginProvider given from the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
RemoveTokenAsync(TUser, String, String, CancellationToken)	Deletes a token for a user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
RemoveUserTokenAsync(TUserToken)	Remove a new user token. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
RemoveUserTokenAsync(TUserToken)	Remove a new user token. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
ReplaceClaimAsync(TUser, Claim, Claim, CancellationToken)	Replaces the claim on the specified user, with the newClaim. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
ReplaceCodesAsync(TUser, IEnumerable<String>, CancellationToken)	Updates the recovery codes for the user while invalidating any previous recovery codes. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
ResetAccessFailedCountAsync(TUser, CancellationToken)	Resets a user's failed access count. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SaveChanges(CancellationToken)	Saves the current store. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SetAuthenticatorKeyAsync(TUser, String, CancellationToken)	Sets the authenticator key for the specified user. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetEmailAsync(TUser, String, CancellationToken)	Sets the email address for a user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SetEmailConfirmedAsync(TUser, Boolean, CancellationToken)	Sets the flag indicating whether the specified user's email address has been confirmed or not. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SetLockoutEnabledAsync(TUser, Boolean, CancellationToken)	Set the flag indicating if the specified user can be locked out.. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SetLockoutEndDateAsync(TUser, Nullable<DateTimeOffset>, CancellationToken)	Locks out a user until the specified end date has passed. Setting a end date in the past immediately unlocks a user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SetNormalizedEmailAsync(TUser, String, CancellationToken)	Sets the normalized email for the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SetNormalizedUserNameAsync(TUser, String, CancellationToken)	Sets the given normalized name for the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SetPasswordHashAsync(TUser, String, CancellationToken)	Sets the password hash for a user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SetPhoneNumberAsync(TUser, String, CancellationToken)	Sets the telephone number for the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SetPhoneNumberConfirmedAsync(TUser, Boolean, CancellationToken)	Sets a flag indicating if the specified user's phone number has been confirmed.. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SetSecurityStampAsync(TUser, String, CancellationToken)	Sets the provided security stamp for the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SetTokenAsync(TUser, String, String, String, CancellationToken)	Sets the token value for a particular user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SetTwoFactorEnabledAsync(TUser, Boolean, CancellationToken)	Sets a flag indicating whether the specified user has two factor authentication enabled or not, as an asynchronous operation. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
SetUserNameAsync(TUser, String, CancellationToken)	Sets the given userName for the specified user. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
ThrowIfDisposed()	Throws if this class has been disposed. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
UpdateAsync(TUser, CancellationToken)	Updates the specified user in the user store. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)