Interface IUserLoginStore
Provides an interface for storing and retrieving user login information from a persistent store.
Namespace: DataWeb.Identity
Assembly: DataWeb.Core.dll
Syntax
public interface IUserLoginStore
Properties
Name
Gets the name of the user login store.
Declaration
string Name { get; }
Property Value
Type |
---|
string |
Methods
AddAsync(string, string, string)
Adds a new user login to the store.
Declaration
Task AddAsync(string userIdMaster, string providerKey, string loginProvider)
Parameters
Type | Name | Description |
---|---|---|
string | userIdMaster | The user IdMaster of the user to add the login for. |
string | providerKey | The provider key of the user login to add. |
string | loginProvider | The name of the login provider. |
Returns
Type | Description |
---|---|
Task | A task representing the asynchronous operation. |
GetLoginAsync(UserLoginFilter)
Gets a user login asynchronously based on the given filter.
Declaration
Task<UserLogin> GetLoginAsync(UserLoginFilter filter)
Parameters
Type | Name | Description |
---|---|---|
UserLoginFilter | filter | The filter to apply to the user login. |
Returns
Type | Description |
---|---|
Task<UserLogin> | A user login that matches the given filter. |
GetLoginsAsync(UserLoginFilter)
Gets a collection of user logins asynchronously based on the given filter.
Declaration
Task<IEnumerable<UserLogin>> GetLoginsAsync(UserLoginFilter filter)
Parameters
Type | Name | Description |
---|---|---|
UserLoginFilter | filter | The filter to apply to the user logins. |
Returns
Type | Description |
---|---|
Task<IEnumerable<UserLogin>> | A collection of user logins that match the given filter. |
RemoveAllAsync(string)
Removes all user logins for a given user.
Declaration
Task RemoveAllAsync(string userIdMaster)
Parameters
Type | Name | Description |
---|---|---|
string | userIdMaster | The user IdMaster of the user to remove logins for. |
Returns
Type | Description |
---|---|
Task | A task representing the asynchronous operation. |
RemoveAsync(string, string, string)
Removes a user login from the store.
Declaration
Task RemoveAsync(string userIdMaster, string providerKey, string loginProvider)
Parameters
Type | Name | Description |
---|---|---|
string | userIdMaster | The user IdMaster of the user to remove the login from. |
string | providerKey | The provider key of the user login to remove. |
string | loginProvider | The name of the login provider. |
Returns
Type | Description |
---|---|
Task | A task representing the asynchronous operation. |