Interface IUserStore

Represents a store for managing user data in the application.

Namespace: DataWeb.Identity

Assembly: DataWeb.Core.dll

Syntax

public interface IUserStore

Properties

Name

Gets the name of the user store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

GetRolesForUserAsync(string, CancellationToken)

Gets the roles that a user belongs to.

Declaration

Task<string[]> GetRolesForUserAsync(string userName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	userName	The name of the user to get the roles for.
CancellationToken	cancellationToken

Returns

Type	Description
Task<string[]>	An array of role names.

GetUserAsync(UserFilter, CancellationToken)

Gets the user that matches the given filter.

Declaration

Task<UserData> GetUserAsync(UserFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UserFilter	filter	The filter to use for querying users.
CancellationToken	cancellationToken

Returns

Type	Description
Task<UserData>	The user data object.

GetUserValueAsync(UserFilter, string, CancellationToken)

Gets the value of a specific property for the user that matches the given filter.

Declaration

Task<object> GetUserValueAsync(UserFilter filter, string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UserFilter	filter	The filter to use for querying users.
string	name	The name of the property to get the value of.
CancellationToken	cancellationToken

Returns

Type	Description
Task<object>	The value of the property.

GetUsersAsync(UserFilter, CancellationToken)

Gets a collection of users based on the given filter.

Declaration

Task<IEnumerable<UserData>> GetUsersAsync(UserFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UserFilter	filter	The filter to use for querying users.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<UserData>>	A collection of user data objects.

IsEmailAvailableAsync(string, string, CancellationToken)

Checks if a given email address is available for use.

Declaration

Task<bool> IsEmailAvailableAsync(string email, string userIDMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	email	The email address to check.
string	userIDMaster	The user Id of the user to check.
CancellationToken	cancellationToken

Returns

Type	Description
Task<bool>	True if the email address is available, false otherwise.

IsUserNameAvailableAsync(string, string, CancellationToken)

Checks if a given user name is available for use.

Declaration

Task<bool> IsUserNameAvailableAsync(string userName, string userIDMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	userName	The user name to check.
string	userIDMaster	The user Id of the user to check.
CancellationToken	cancellationToken

Returns

Type	Description
Task<bool>	True if the user name is available, false otherwise.