Table of Contents

Class MemberController

Namespace
Umbraco.Cms.Web.BackOffice.Controllers
Assembly
Umbraco.Web.BackOffice.dll
[Authorize(Policy = "SectionAccessMembers")]
public class MemberController : ContentControllerBase
Inheritance
MemberController
Inherited Members

Remarks

This controller is decorated with the UmbracoApplicationAuthorizeAttribute which means that any user requesting access to ALL of the methods on this controller will need access to the member application.

Constructors

MemberController(ICultureDictionary, ILoggerFactory, IShortStringHelper, IEventMessagesFactory, ILocalizedTextService, PropertyEditorCollection, IUmbracoMapper, IMemberService, IMemberTypeService, IMemberManager, IDataTypeService, IBackOfficeSecurityAccessor, IJsonSerializer, IPasswordChanger<MemberIdentityUser>, ICoreScopeProvider) 

[Obsolete("Use constructor that also takes an ITwoFactorLoginService. Scheduled for removal in V13")]
public MemberController(ICultureDictionary cultureDictionary, ILoggerFactory loggerFactory, IShortStringHelper shortStringHelper, IEventMessagesFactory eventMessages, ILocalizedTextService localizedTextService, PropertyEditorCollection propertyEditors, IUmbracoMapper umbracoMapper, IMemberService memberService, IMemberTypeService memberTypeService, IMemberManager memberManager, IDataTypeService dataTypeService, IBackOfficeSecurityAccessor backOfficeSecurityAccessor, IJsonSerializer jsonSerializer, IPasswordChanger<MemberIdentityUser> passwordChanger, ICoreScopeProvider scopeProvider)

Parameters

cultureDictionary ICultureDictionary
loggerFactory ILoggerFactory
shortStringHelper IShortStringHelper
eventMessages IEventMessagesFactory
localizedTextService ILocalizedTextService
propertyEditors PropertyEditorCollection
umbracoMapper IUmbracoMapper
memberService IMemberService
memberTypeService IMemberTypeService
memberManager IMemberManager
dataTypeService IDataTypeService
backOfficeSecurityAccessor IBackOfficeSecurityAccessor
jsonSerializer IJsonSerializer
passwordChanger IPasswordChanger<MemberIdentityUser>
scopeProvider ICoreScopeProvider

MemberController(ICultureDictionary, ILoggerFactory, IShortStringHelper, IEventMessagesFactory, ILocalizedTextService, PropertyEditorCollection, IUmbracoMapper, IMemberService, IMemberTypeService, IMemberManager, IDataTypeService, IBackOfficeSecurityAccessor, IJsonSerializer, IPasswordChanger<MemberIdentityUser>, ICoreScopeProvider, ITwoFactorLoginService)

Initializes a new instance of the MemberController class.

[ActivatorUtilitiesConstructor]
public MemberController(ICultureDictionary cultureDictionary, ILoggerFactory loggerFactory, IShortStringHelper shortStringHelper, IEventMessagesFactory eventMessages, ILocalizedTextService localizedTextService, PropertyEditorCollection propertyEditors, IUmbracoMapper umbracoMapper, IMemberService memberService, IMemberTypeService memberTypeService, IMemberManager memberManager, IDataTypeService dataTypeService, IBackOfficeSecurityAccessor backOfficeSecurityAccessor, IJsonSerializer jsonSerializer, IPasswordChanger<MemberIdentityUser> passwordChanger, ICoreScopeProvider scopeProvider, ITwoFactorLoginService twoFactorLoginService)

Parameters

cultureDictionary ICultureDictionary

The culture dictionary

loggerFactory ILoggerFactory

The logger factory

shortStringHelper IShortStringHelper

The string helper

eventMessages IEventMessagesFactory

The event messages factory

localizedTextService ILocalizedTextService

The entry point for localizing key services

propertyEditors PropertyEditorCollection

The property editors

umbracoMapper IUmbracoMapper

The mapper

memberService IMemberService

The member service

memberTypeService IMemberTypeService

The member type service

memberManager IMemberManager

The member manager

dataTypeService IDataTypeService

The data-type service

backOfficeSecurityAccessor IBackOfficeSecurityAccessor

The back office security accessor

jsonSerializer IJsonSerializer

The JSON serializer

passwordChanger IPasswordChanger<MemberIdentityUser>

The password changer

scopeProvider ICoreScopeProvider

The core scope provider

twoFactorLoginService ITwoFactorLoginService

The two factor login service

Methods

DeleteByKey(Guid)

Permanently deletes a member

[HttpPost]
public IActionResult DeleteByKey(Guid key)

Parameters

key Guid

Guid of the member to delete

Returns

IActionResult

The result of the deletion

ExportMemberData(Guid)

Exports member data based on their unique Id

[HttpGet]
public IActionResult ExportMemberData(Guid key)

Parameters

key Guid

The unique member identifier

Returns

IActionResult

HttpResponseMessage

GetByKey(Guid)

Gets the content json for the member

public MemberDisplay? GetByKey(Guid key)

Parameters

key Guid

The Guid key of the member

Returns

MemberDisplay

The member for display

GetEmpty(string?)

Gets an empty content item for the

public ActionResult<MemberDisplay?> GetEmpty(string? contentTypeAlias = null)

Parameters

contentTypeAlias string

The content type

Returns

ActionResult<MemberDisplay>

The empty member for display

GetListNodeDisplay(string)

Returns a display node with a list view to render members

public MemberListDisplay GetListNodeDisplay(string listName)

Parameters

listName string

The member type to list

Returns

MemberListDisplay

The member list for display

GetPagedResults(int, int, string, Direction, bool, string, string?)

The paginated list of members

public PagedResult<MemberBasic> GetPagedResults(int pageNumber = 1, int pageSize = 100, string orderBy = "username", Direction orderDirection = 0, bool orderBySystemField = true, string filter = "", string? memberTypeAlias = null)

Parameters

pageNumber int

The page number to display

pageSize int

The size of the page

orderBy string

The ordering of the member list

orderDirection Direction

The direction of the member list

orderBySystemField bool

The system field to order by

filter string

The current filter for the list

memberTypeAlias string

The member type

Returns

PagedResult<MemberBasic>

The paged result of members

PostSave(MemberSave)

Saves member

[FileUploadCleanupFilter(true)]
public Task<ActionResult<MemberDisplay?>> PostSave(MemberSave contentItem)

Parameters

contentItem MemberSave

The content item to save as a member

Returns

Task<ActionResult<MemberDisplay>>

The resulting member display object