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 |
---|
string |
Methods
GetRolesForUserAsync(string)
Gets the roles that a user belongs to.
Declaration
Task<string[]> GetRolesForUserAsync(string userName)
Parameters
Type | Name | Description |
---|---|---|
string | userName | The name of the user to get the roles for. |
Returns
Type | Description |
---|---|
Task<string[]> | An array of role names. |
GetUserAsync(UserFilter)
Gets the user that matches the given filter.
Declaration
Task<UserData> GetUserAsync(UserFilter filter)
Parameters
Type | Name | Description |
---|---|---|
UserFilter | filter | The filter to use for querying users. |
Returns
Type | Description |
---|---|
Task<UserData> | The user data object. |
GetUsersAsync(UserFilter)
Gets a collection of users based on the given filter.
Declaration
Task<IEnumerable<UserData>> GetUsersAsync(UserFilter filter)
Parameters
Type | Name | Description |
---|---|---|
UserFilter | filter | The filter to use for querying users. |
Returns
Type | Description |
---|---|
Task<IEnumerable<UserData>> | A collection of user data objects. |
GetUserValueAsync(UserFilter, string)
Gets the value of a specific property for the user that matches the given filter.
Declaration
Task<object> GetUserValueAsync(UserFilter filter, string name)
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. |
Returns
Type | Description |
---|---|
Task<object> | The value of the property. |
IsEmailAvailableAsync(string, string)
Checks if a given email address is available for use.
Declaration
Task<bool> IsEmailAvailableAsync(string email, string userIDMaster)
Parameters
Type | Name | Description |
---|---|---|
string | The email address to check. |
|
string | userIDMaster | The user Id of the user to check. |
Returns
Type | Description |
---|---|
Task<bool> | True if the email address is available, false otherwise. |
IsUserNameAvailableAsync(string, string)
Checks if a given user name is available for use.
Declaration
Task<bool> IsUserNameAvailableAsync(string userName, string userIDMaster)
Parameters
Type | Name | Description |
---|---|---|
string | userName | The user name to check. |
string | userIDMaster | The user Id of the user to check. |
Returns
Type | Description |
---|---|
Task<bool> | True if the user name is available, false otherwise. |