Interface IBackOfficeUserStore
Manages persistence of users.
Namespace: Umbraco.Cms.Core.Security
Assembly: Umbraco.Core.dll
Syntax
public interface IBackOfficeUserStoreMethods
View SourceDisableAsync(IUser)
Disables an IUser
Declaration
Task<UserOperationStatus> DisableAsync(IUser user)Parameters
| Type | Name | Description |
|---|---|---|
| IUser | user | IUser to disable. |
Returns
| Type | Description |
|---|---|
| Task<UserOperationStatus> | A task resolving into an UserOperationStatus. |
GetAllInGroupAsync(int)
Gets a list of IUser objects associated with a given group
Declaration
Task<IEnumerable<IUser>> GetAllInGroupAsync(int groupId)Parameters
| Type | Name | Description |
|---|---|---|
| int | groupId | Id of group. |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<IUser>> | A task resolving into an System.Collections.Generic.IEnumerable<T> |
GetAsync(Guid)
Gets a user by it's key.
Declaration
Task<IUser?> GetAsync(Guid key)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | key | Key of the user to retrieve. |
Returns
| Type | Description |
|---|---|
| Task<IUser> | Task resolving into an IUser. |
GetAsync(int)
Gets a user by Id
Declaration
Task<IUser?> GetAsync(int id)Parameters
| Type | Name | Description |
|---|---|---|
| int | id | Id of the user to retrieve |
Returns
| Type | Description |
|---|---|
| Task<IUser> | A task resolving into an IUser |
GetByEmailAsync(string)
Get an IUser by email
Declaration
Task<IUser?> GetByEmailAsync(string email)Parameters
| Type | Name | Description |
|---|---|---|
| string | Email to use for retrieval. |
Returns
| Type | Description |
|---|---|
| Task<IUser> | A task resolving into an IUser |
GetByUserNameAsync(string)
Get an IUser by username
Declaration
Task<IUser?> GetByUserNameAsync(string username)Parameters
| Type | Name | Description |
|---|---|---|
| string | username | Username to use for retrieval. |
Returns
| Type | Description |
|---|---|
| Task<IUser> | A task resolving into an IUser |
GetUsersAsync(params Guid[]?)
Declaration
Task<IEnumerable<IUser>> GetUsersAsync(params Guid[]? keys)Parameters
| Type | Name | Description |
|---|---|---|
| Guid[] | keys |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<IUser>> |
GetUsersAsync(params int[]?)
Declaration
Task<IEnumerable<IUser>> GetUsersAsync(params int[]? ids)Parameters
| Type | Name | Description |
|---|---|---|
| int[] | ids |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<IUser>> |
SaveAsync(IUser)
Saves an IUser
Declaration
Task<UserOperationStatus> SaveAsync(IUser user)Parameters
| Type | Name | Description |
|---|---|---|
| IUser | user | IUser to Save |
Returns
| Type | Description |
|---|---|
| Task<UserOperationStatus> | A task resolving into an UserOperationStatus. |