Search Results for

    Show / Hide Table of Contents
    View Source

    Interface IMemberGroupService

    Namespace: Umbraco.Cms.Core.Services
    Assembly: Umbraco.Core.dll
    Syntax
    public interface IMemberGroupService : IService

    Methods

    View Source

    CreateAsync(IMemberGroup)

    Creates a new IMemberGroup object

    Declaration
    Task<Attempt<IMemberGroup, MemberGroupOperationStatus>> CreateAsync(IMemberGroup memberGroup)
    Parameters
    Type Name Description
    IMemberGroup memberGroup

    IMemberGroup to create

    Returns
    Type Description
    Task<Attempt<IMemberGroup, MemberGroupOperationStatus>>

    An attempt with a status of whether the operation was successful or not, and the created object if it succeeded.

    View Source

    Delete(IMemberGroup)

    Declaration
    void Delete(IMemberGroup memberGroup)
    Parameters
    Type Name Description
    IMemberGroup memberGroup
    View Source

    DeleteAsync(Guid)

    Deletes a IMemberGroup by removing it and its usages from the db

    Declaration
    Task<Attempt<IMemberGroup, MemberGroupOperationStatus>> DeleteAsync(Guid key)
    Parameters
    Type Name Description
    Guid key

    The key of the IMemberGroup to delete

    Returns
    Type Description
    Task<Attempt<IMemberGroup, MemberGroupOperationStatus>>
    View Source

    GetAll()

    Declaration
    IEnumerable<IMemberGroup> GetAll()
    Returns
    Type Description
    IEnumerable<IMemberGroup>
    View Source

    GetAllAsync()

    Gets all member groups

    Declaration
    Task<IEnumerable<IMemberGroup>> GetAllAsync()
    Returns
    Type Description
    Task<IEnumerable<IMemberGroup>>

    An enumerable list of IMemberGroup objects.

    View Source

    GetAsync(Guid)

    Get a member group by key.

    Declaration
    Task<IMemberGroup> GetAsync(Guid key)
    Parameters
    Type Name Description
    Guid key

    of the member group to get.

    Returns
    Type Description
    Task<IMemberGroup>

    A IMemberGroup object.

    View Source

    GetById(Guid)

    Declaration
    IMemberGroup GetById(Guid id)
    Parameters
    Type Name Description
    Guid id
    Returns
    Type Description
    IMemberGroup
    View Source

    GetById(Int32)

    Declaration
    IMemberGroup GetById(int id)
    Parameters
    Type Name Description
    System.Int32 id
    Returns
    Type Description
    IMemberGroup
    View Source

    GetByIds(IEnumerable<Int32>)

    Declaration
    IEnumerable<IMemberGroup> GetByIds(IEnumerable<int> ids)
    Parameters
    Type Name Description
    IEnumerable<System.Int32> ids
    Returns
    Type Description
    IEnumerable<IMemberGroup>
    View Source

    GetByIdsAsync(IEnumerable<Int32>)

    Gets a list of member groups with the given ids.

    Declaration
    Task<IEnumerable<IMemberGroup>> GetByIdsAsync(IEnumerable<int> ids)
    Parameters
    Type Name Description
    IEnumerable<System.Int32> ids

    An enumerable list of System.Int32 ids, to get the member groups by.

    Returns
    Type Description
    Task<IEnumerable<IMemberGroup>>

    An enumerable list of IMemberGroup objects.

    View Source

    GetByName(String)

    Declaration
    IMemberGroup GetByName(string name)
    Parameters
    Type Name Description
    System.String name
    Returns
    Type Description
    IMemberGroup
    View Source

    GetByNameAsync(String)

    Get a member group by name.

    Declaration
    Task<IMemberGroup> GetByNameAsync(string name)
    Parameters
    Type Name Description
    System.String name

    Name of the member group to get.

    Returns
    Type Description
    Task<IMemberGroup>

    A IMemberGroup object.

    View Source

    Save(IMemberGroup)

    Declaration
    void Save(IMemberGroup memberGroup)
    Parameters
    Type Name Description
    IMemberGroup memberGroup
    View Source

    UpdateAsync(IMemberGroup)

    Updates IMemberGroup object

    Declaration
    Task<Attempt<IMemberGroup, MemberGroupOperationStatus>> UpdateAsync(IMemberGroup memberGroup)
    Parameters
    Type Name Description
    IMemberGroup memberGroup

    IMemberGroup to create

    Returns
    Type Description
    Task<Attempt<IMemberGroup, MemberGroupOperationStatus>>

    An attempt with a status of whether the operation was successful or not, and the object.

    • Improve this Doc
    • View Source
    In This Article
    • Methods
      • CreateAsync(IMemberGroup)
      • Delete(IMemberGroup)
      • DeleteAsync(Guid)
      • GetAll()
      • GetAllAsync()
      • GetAsync(Guid)
      • GetById(Guid)
      • GetById(Int32)
      • GetByIds(IEnumerable<Int32>)
      • GetByIdsAsync(IEnumerable<Int32>)
      • GetByName(String)
      • GetByNameAsync(String)
      • Save(IMemberGroup)
      • UpdateAsync(IMemberGroup)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX