Search Results for

    Show / Hide Table of Contents
    View Source

    Interface IBackOfficeUserStore

    Manages persistence of users.

    Namespace: Umbraco.Cms.Core.Security
    Assembly: Umbraco.Core.dll
    Syntax
    public interface IBackOfficeUserStore

    Methods

    View Source

    DisableAsync(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.

    View Source

    GetAllInGroupAsync(Int32)

    Gets a list of IUser objects associated with a given group

    Declaration
    Task<IEnumerable<IUser>> GetAllInGroupAsync(int groupId)
    Parameters
    Type Name Description
    System.Int32 groupId

    Id of group.

    Returns
    Type Description
    Task<IEnumerable<IUser>>

    A task resolving into an

    View Source

    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.

    View Source

    GetAsync(Int32)

    Gets a user by Id

    Declaration
    Task<IUser> GetAsync(int id)
    Parameters
    Type Name Description
    System.Int32 id

    Id of the user to retrieve

    Returns
    Type Description
    Task<IUser>

    A task resolving into an IUser

    View Source

    GetByEmailAsync(String)

    Get an IUser by email

    Declaration
    Task<IUser> GetByEmailAsync(string email)
    Parameters
    Type Name Description
    System.String email

    Email to use for retrieval.

    Returns
    Type Description
    Task<IUser>

    A task resolving into an IUser

    View Source

    GetByUserNameAsync(String)

    Get an IUser by username

    Declaration
    Task<IUser> GetByUserNameAsync(string username)
    Parameters
    Type Name Description
    System.String username

    Username to use for retrieval.

    Returns
    Type Description
    Task<IUser>

    A task resolving into an IUser

    View Source

    GetUsersAsync(Guid[])

    Declaration
    Task<IEnumerable<IUser>> GetUsersAsync(params Guid[] keys)
    Parameters
    Type Name Description
    Guid[] keys
    Returns
    Type Description
    Task<IEnumerable<IUser>>
    View Source

    GetUsersAsync(Int32[])

    Declaration
    Task<IEnumerable<IUser>> GetUsersAsync(params int[] ids)
    Parameters
    Type Name Description
    System.Int32[] ids
    Returns
    Type Description
    Task<IEnumerable<IUser>>
    View Source

    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.

    • Improve this Doc
    • View Source
    In This Article
    • Methods
      • DisableAsync(IUser)
      • GetAllInGroupAsync(Int32)
      • GetAsync(Guid)
      • GetAsync(Int32)
      • GetByEmailAsync(String)
      • GetByUserNameAsync(String)
      • GetUsersAsync(Guid[])
      • GetUsersAsync(Int32[])
      • SaveAsync(IUser)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX