View Source

Class MemberController

Inheritance

System.Object

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

BackOfficeNotificationsController

ContentControllerBase

Namespace: Umbraco.Web.Editors

Assembly: Umbraco.Web.dll

Syntax

[PluginController("UmbracoApi")]
public class MemberController : ContentControllerBase, IDiscoverable

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(PropertyEditorCollection, IGlobalSettings, IUmbracoContextAccessor, ISqlContext, ServiceContext, AppCaches, IProfilingLogger, IRuntimeState, UmbracoHelper)

Declaration

public MemberController(PropertyEditorCollection propertyEditors, IGlobalSettings globalSettings, IUmbracoContextAccessor umbracoContextAccessor, ISqlContext sqlContext, ServiceContext services, AppCaches appCaches, IProfilingLogger logger, IRuntimeState runtimeState, UmbracoHelper umbracoHelper)

Parameters

Type	Name	Description
PropertyEditorCollection	propertyEditors
IGlobalSettings	globalSettings
IUmbracoContextAccessor	umbracoContextAccessor
ISqlContext	sqlContext
ServiceContext	services
AppCaches	appCaches
IProfilingLogger	logger
IRuntimeState	runtimeState
UmbracoHelper	umbracoHelper

Properties

MembershipScenario

Returns the currently configured membership scenario for members in umbraco

Declaration

protected MembershipScenario MembershipScenario { get; }

Property Value

Type	Description
MembershipScenario

Methods

DeleteByKey(Guid)

Permanently deletes a member

Declaration

public HttpResponseMessage DeleteByKey(Guid key)

Parameters

Type	Name	Description
System.Guid	key

Returns

Type	Description
HttpResponseMessage

ExportMemberData(Guid)

Exports member data based on their unique Id

Declaration

public HttpResponseMessage ExportMemberData(Guid key)

Parameters

Type	Name	Description
System.Guid	key	The unique System.Guid

Returns

Type	Description
HttpResponseMessage

GetByKey(Guid)

Gets the content json for the member

Declaration

public MemberDisplay GetByKey(Guid key)

Parameters

Type	Name	Description
System.Guid	key

Returns

Type	Description
MemberDisplay

GetEmpty(String)

Gets an empty content item for the

Declaration

public MemberDisplay GetEmpty(string contentTypeAlias = null)

Parameters

Type	Name	Description
System.String	contentTypeAlias

Returns

Type	Description
MemberDisplay

GetListNodeDisplay(String)

Returns a display node with a list view to render members

Declaration

public MemberListDisplay GetListNodeDisplay(string listName)

Parameters

Type	Name	Description
System.String	listName

Returns

Type	Description
MemberListDisplay

GetPagedResults(Int32, Int32, String, Direction, Boolean, String, String)

Declaration

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

Parameters

Type	Name	Description
System.Int32	pageNumber
System.Int32	pageSize
System.String	orderBy
Direction	orderDirection
System.Boolean	orderBySystemField
System.String	filter
System.String	memberTypeAlias

Returns

Type	Description
PagedResult<MemberBasic>

PostSave(MemberSave)

Saves member

Declaration

public MemberDisplay PostSave(MemberSave contentItem)

Parameters

Type	Name	Description
MemberSave	contentItem

Returns

Type	Description
MemberDisplay