Search Results for

    Show / Hide Table of Contents
    View Source

    Class MemberGroupController

    An API controller used for dealing with member groups

    Inheritance
    System.Object
    Microsoft.AspNetCore.Mvc.ControllerBase
    UmbracoApiControllerBase
    UmbracoApiController
    UmbracoAuthorizedApiController
    UmbracoAuthorizedJsonController
    Namespace: Umbraco.Cms.Web.BackOffice.Controllers
    Assembly: Umbraco.Web.BackOffice.dll
    Syntax
    [Authorize(Policy = "TreeAccessMemberGroups")]
    public class MemberGroupController : UmbracoAuthorizedJsonController

    Constructors

    View Source

    MemberGroupController(IMemberGroupService, IUmbracoMapper, ILocalizedTextService)

    Declaration
    public MemberGroupController(IMemberGroupService memberGroupService, IUmbracoMapper umbracoMapper, ILocalizedTextService localizedTextService)
    Parameters
    Type Name Description
    IMemberGroupService memberGroupService
    IUmbracoMapper umbracoMapper
    ILocalizedTextService localizedTextService

    Methods

    View Source

    DeleteById(Int32)

    Declaration
    [HttpDelete]
    [HttpPost]
    public IActionResult DeleteById(int id)
    Parameters
    Type Name Description
    System.Int32 id
    Returns
    Type Description
    Microsoft.AspNetCore.Mvc.IActionResult
    View Source

    GetAllGroups()

    Declaration
    public IEnumerable<MemberGroupDisplay> GetAllGroups()
    Returns
    Type Description
    IEnumerable<MemberGroupDisplay>
    View Source

    GetById(Guid)

    Gets the member group json for the member group guid

    Declaration
    public ActionResult<MemberGroupDisplay?> GetById(Guid id)
    Parameters
    Type Name Description
    Guid id
    Returns
    Type Description
    Microsoft.AspNetCore.Mvc.ActionResult<System.Nullable<MemberGroupDisplay>>
    View Source

    GetById(Int32)

    Gets the member group json for the member group id

    Declaration
    public ActionResult<MemberGroupDisplay?> GetById(int id)
    Parameters
    Type Name Description
    System.Int32 id
    Returns
    Type Description
    Microsoft.AspNetCore.Mvc.ActionResult<System.Nullable<MemberGroupDisplay>>
    View Source

    GetById(Udi)

    Gets the member group json for the member group udi

    Declaration
    public ActionResult<MemberGroupDisplay?> GetById(Udi id)
    Parameters
    Type Name Description
    Udi id
    Returns
    Type Description
    Microsoft.AspNetCore.Mvc.ActionResult<System.Nullable<MemberGroupDisplay>>
    View Source

    GetByIds(Int32[])

    Declaration
    public IEnumerable<MemberGroupDisplay> GetByIds([FromQuery] int[] ids)
    Parameters
    Type Name Description
    System.Int32[] ids
    Returns
    Type Description
    IEnumerable<MemberGroupDisplay>
    View Source

    GetEmpty()

    Declaration
    public MemberGroupDisplay? GetEmpty()
    Returns
    Type Description
    System.Nullable<MemberGroupDisplay>
    View Source

    IsMemberGroupNameUnique(Int32, String, String)

    Declaration
    public bool IsMemberGroupNameUnique(int id, string oldName, string newName)
    Parameters
    Type Name Description
    System.Int32 id
    System.String oldName
    System.String newName
    Returns
    Type Description
    System.Boolean
    View Source

    PostSave(MemberGroupSave)

    Declaration
    public ActionResult<MemberGroupDisplay?> PostSave(MemberGroupSave saveModel)
    Parameters
    Type Name Description
    MemberGroupSave saveModel
    Returns
    Type Description
    Microsoft.AspNetCore.Mvc.ActionResult<System.Nullable<MemberGroupDisplay>>
    • Improve this Doc
    • View Source
    In This Article
    • Constructors
      • MemberGroupController(IMemberGroupService, IUmbracoMapper, ILocalizedTextService)
    • Methods
      • DeleteById(Int32)
      • GetAllGroups()
      • GetById(Guid)
      • GetById(Int32)
      • GetById(Udi)
      • GetByIds(Int32[])
      • GetEmpty()
      • IsMemberGroupNameUnique(Int32, String, String)
      • PostSave(MemberGroupSave)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX