UserStore<TUser,TRole,TContext> Class

Definition

Namespace:: Microsoft.AspNetCore.Identity.EntityFrameworkCore

Assembly:: Microsoft.AspNetCore.Identity.EntityFrameworkCore.dll

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v1.0.0

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v1.1.0

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v10.0.0-preview.7.25380.108

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v2.0.0

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v2.1.0

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v2.2.0

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v3.0.3

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v3.1.18

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v5.0.9

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v6.0.6

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v7.0.5

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v8.0.19

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v9.0.8

Source:: UserStore.cs

Source:: UserStore.cs

Source:: UserStore.cs

Source:: UserStore.cs

Source:: UserStore.cs

Source:: UserStore.cs

Source:: UserStore.cs

Source:: UserStore.cs

Source:: UserStore.cs

Source:: UserStore.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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: UserStore<TUser,TRole,TContext,TKey,IdentityUserClaim<TKey>,IdentityUserRole<TKey>,IdentityUserLogin<TKey>,IdentityUserToken<TKey>>

UserStore<TUser,TRole,TContext,String>
UserStore<TUser,TRole,TContext>

Inheritance: UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim,IdentityUserPasskey<TKey>>

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

UserStore<TUser,TRole,TContext,String>
UserStore<TUser,TRole,TContext>

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>)
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 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>)
ConvertIdToString(TKey)	Converts the provided `id` to its string representation. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
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>)
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 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>)
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 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>)
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>)
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>)
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>)
GetLoginsAsync(TUser, CancellationToken)	Retrieves the associated logins for the specified <param ref="user" />. (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>)
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>)
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>)
RemoveUserTokenAsync(TUserToken)	Remove a new user token. (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>)
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>)
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>)
UpdateAsync(TUser, CancellationToken)	Updates the specified `user` in the user store. (Inherited from UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)

Applies to

Feedback

Was this page helpful?