IUserRoleStore<TUser> Interface

Definition

Namespace:
Microsoft.AspNetCore.Identity
Assembly:
Microsoft.AspNetCore.Identity.dll
Assembly:
Microsoft.Extensions.Identity.Core.dll
Package:
Microsoft.AspNetCore.Identity v1.0.0
Package:
Microsoft.AspNetCore.Identity v1.1.0
Package:
Microsoft.Extensions.Identity.Core v2.0.0
Package:
Microsoft.Extensions.Identity.Core v2.1.0
Package:
Microsoft.Extensions.Identity.Core v2.2.0
Package:
Microsoft.Extensions.Identity.Core v3.0.3
Package:
Microsoft.Extensions.Identity.Core v3.1.18
Package:
Microsoft.Extensions.Identity.Core v5.0.9
Package:
Microsoft.Extensions.Identity.Core v6.0.0

Provides an abstraction for a store which maps users to roles.

generic <typename TUser>
 where TUser : classpublic interface class IUserRoleStore : IDisposable, Microsoft::AspNetCore::Identity::IUserStore<TUser>
public interface IUserRoleStore<TUser> : IDisposable, Microsoft.AspNetCore.Identity.IUserStore<TUser> where TUser : class
type IUserRoleStore<'User (requires 'User : null)> = interface
    interface IUserStore<'User (requires 'User : null)>
    interface IDisposable
Public Interface IUserRoleStore(Of TUser)
Implements IDisposable, IUserStore(Of TUser)

Type Parameters

TUser

The type encapsulating a user.

Derived
Implements
IUserStore<TUser> IDisposable

Methods

AddToRoleAsync(TUser, String, CancellationToken)

Add the specified user to the named role.
CreateAsync(TUser, CancellationToken)

Creates the specified user in the user store.

(Inherited from IUserStore<TUser>)
DeleteAsync(TUser, CancellationToken)

Deletes the specified user from the user store.

(Inherited from IUserStore<TUser>)
FindByIdAsync(String, CancellationToken)

Finds and returns a user, if any, who has the specified userId.

(Inherited from IUserStore<TUser>)
FindByNameAsync(String, CancellationToken)

Finds and returns a user, if any, who has the specified normalized user name.

(Inherited from IUserStore<TUser>)
GetNormalizedUserNameAsync(TUser, CancellationToken)

Gets the normalized user name for the specified user.

(Inherited from IUserStore<TUser>)
GetRolesAsync(TUser, CancellationToken)

Gets a list of role names the specified user belongs to.
GetUserIdAsync(TUser, CancellationToken)

Gets the user identifier for the specified user.

(Inherited from IUserStore<TUser>)
GetUserNameAsync(TUser, CancellationToken)

Gets the user name for the specified user.

(Inherited from IUserStore<TUser>)
GetUsersInRoleAsync(String, CancellationToken)

Returns a list of Users who are members of the named role.
IsInRoleAsync(TUser, String, CancellationToken)

Returns a flag indicating whether the specified user is a member of the given named role.
RemoveFromRoleAsync(TUser, String, CancellationToken)

Remove the specified user from the named role.
SetNormalizedUserNameAsync(TUser, String, CancellationToken)

Sets the given normalized name for the specified user.

(Inherited from IUserStore<TUser>)
SetUserNameAsync(TUser, String, CancellationToken)

Sets the given userName for the specified user.

(Inherited from IUserStore<TUser>)
UpdateAsync(TUser, CancellationToken)

Updates the specified user in the user store.

(Inherited from IUserStore<TUser>)

Applies to