Interface IUserSearchStore<TListUser>

Provides an abstraction for a store which combines user and person.

Namespace: IRM.AspNetCore.Identity

Assembly: IRM.AspNetCore.Identity.dll

Syntax

public interface IUserSearchStore<TListUser>
    where TListUser : class, IListUser

Type Parameters

TListUser

Methods

GetAllUsersAsync(UsersSearchQuery, CancellationToken)

Gets all users that matches the supplied query.

Declaration

Task<QueryResult<TListUser>> GetAllUsersAsync(UsersSearchQuery query, CancellationToken cancellationToken = default(CancellationToken))

Parameters

UsersSearchQuery query The query describing filtering and sorting for the users.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task<QueryResult<TListUser>> A QueryResult<T> with a collection of users matching the supplied query.

GetUsersInRoleAsync(UsersInRoleSearchQuery, CancellationToken)

Gets all users that matches the supplied query and the specified role.

Declaration

Task<QueryResult<TListUser>> GetUsersInRoleAsync(UsersInRoleSearchQuery query, CancellationToken cancellationToken = default(CancellationToken))

Parameters

UsersInRoleSearchQuery query The query describing the role id, filtering and sorting for the users.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task<QueryResult<TListUser>> A QueryResult<T> with a collection of users matching the supplied query.