Search Results for

    Show / Hide Table of Contents
    View Source

    Interface IBackOfficeUserReader

    Provides shared read access to back office users for both IUserService and IBackOfficeUserStore.

    Namespace: Umbraco.Cms.Core.Services
    Assembly: Umbraco.Core.dll
    Syntax
    public interface IBackOfficeUserReader
    Remarks

    Centralises the repository calls so the two consumers cannot drift. Registered independently of IBackOfficeUserStore so it is available in delivery-only setups.

    Methods

    View Source

    GetAllInGroup(int)

    Retrieves all back office users that belong to the specified user group.

    Declaration
    IEnumerable<IUser> GetAllInGroup(int groupId)
    Parameters
    Type Name Description
    int groupId

    The integer identifier of the user group.

    Returns
    Type Description
    IEnumerable<IUser>

    The users in the group, or an empty collection if the group has no members.

    View Source

    GetById(int)

    Retrieves a back office user by their integer identifier, falling back to a minimal upgrade-safe query if the user table schema is mid-migration.

    Declaration
    IUser? GetById(int id)
    Parameters
    Type Name Description
    int id

    The integer identifier of the user.

    Returns
    Type Description
    IUser

    The IUser if found; otherwise, null.

    View Source

    GetByKey(Guid)

    Retrieves a back office user by their unique key.

    Declaration
    IUser? GetByKey(Guid key)
    Parameters
    Type Name Description
    Guid key

    The unique key of the user.

    Returns
    Type Description
    IUser

    The IUser if found; otherwise, null.

    View Source

    GetManyById(IEnumerable<int>)

    Retrieves the back office users with the specified integer identifiers.

    Declaration
    IEnumerable<IUser> GetManyById(IEnumerable<int> ids)
    Parameters
    Type Name Description
    IEnumerable<int> ids

    The integer identifiers of the users to retrieve.

    Returns
    Type Description
    IEnumerable<IUser>

    The matching users, or an empty collection if ids is empty.

    View Source

    GetManyByKey(IEnumerable<Guid>)

    Retrieves the back office users with the specified unique keys.

    Declaration
    IEnumerable<IUser> GetManyByKey(IEnumerable<Guid> keys)
    Parameters
    Type Name Description
    IEnumerable<Guid> keys

    The unique keys of the users to retrieve.

    Returns
    Type Description
    IEnumerable<IUser>

    The matching users, or an empty collection if keys is empty.

    • View Source
    In this article
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX