View Source

Class MemberManager

Inheritance

object

UserManager<MemberIdentityUser>

UmbracoUserManager<MemberIdentityUser, MemberPasswordConfigurationSettings>

Namespace: Umbraco.Cms.Web.Common.Security

Assembly: Umbraco.Web.Common.dll

Syntax

public class MemberManager : UmbracoUserManager<MemberIdentityUser, MemberPasswordConfigurationSettings>, IMemberManager, IUmbracoUserManager<MemberIdentityUser>

Constructors

MemberManager(IIpResolver, IMemberUserStore, IOptions<IdentityOptions>, IPasswordHasher<MemberIdentityUser>, IEnumerable<IUserValidator<MemberIdentityUser>>, IEnumerable<IPasswordValidator<MemberIdentityUser>>, IdentityErrorDescriber, IServiceProvider, ILogger<UserManager<MemberIdentityUser>>, IOptionsSnapshot<MemberPasswordConfigurationSettings>, IPublicAccessService, IHttpContextAccessor)

Declaration

public MemberManager(IIpResolver ipResolver, IMemberUserStore store, IOptions<IdentityOptions> optionsAccessor, IPasswordHasher<MemberIdentityUser> passwordHasher, IEnumerable<IUserValidator<MemberIdentityUser>> userValidators, IEnumerable<IPasswordValidator<MemberIdentityUser>> passwordValidators, IdentityErrorDescriber errors, IServiceProvider services, ILogger<UserManager<MemberIdentityUser>> logger, IOptionsSnapshot<MemberPasswordConfigurationSettings> passwordConfiguration, IPublicAccessService publicAccessService, IHttpContextAccessor httpContextAccessor)

Parameters

Type	Name	Description
IIpResolver	ipResolver
IMemberUserStore	store
IOptions<IdentityOptions>	optionsAccessor
IPasswordHasher<MemberIdentityUser>	passwordHasher
IEnumerable<IUserValidator<MemberIdentityUser>>	userValidators
IEnumerable<IPasswordValidator<MemberIdentityUser>>	passwordValidators
IdentityErrorDescriber	errors
IServiceProvider	services
ILogger<UserManager<MemberIdentityUser>>	logger
IOptionsSnapshot<MemberPasswordConfigurationSettings>	passwordConfiguration
IPublicAccessService	publicAccessService
IHttpContextAccessor	httpContextAccessor

Methods

AsPublishedMember(MemberIdentityUser)

Returns the IPublishedContent instance for the specified MemberIdentityUser

Declaration

public virtual IPublishedContent? AsPublishedMember(MemberIdentityUser user)

Parameters

Type	Name	Description
MemberIdentityUser	user

Returns

Type	Description
IPublishedContent

GetCurrentMemberAsync()

Returns the currently logged in member if there is one, else returns null

Declaration

public virtual Task<MemberIdentityUser?> GetCurrentMemberAsync()

Returns

Type	Description
Task<MemberIdentityUser>

IsLoggedIn()

Check if a member is logged in

Declaration

public virtual bool IsLoggedIn()

Returns

Type	Description
bool

IsMemberAuthorizedAsync(IEnumerable<string>?, IEnumerable<string>?, IEnumerable<int>?)

Checks if the current member is authorized based on the parameters provided.

Declaration

public virtual Task<bool> IsMemberAuthorizedAsync(IEnumerable<string>? allowTypes = null, IEnumerable<string>? allowGroups = null, IEnumerable<int>? allowMembers = null)

Parameters

Type	Name	Description
IEnumerable<string>	allowTypes	Allowed types.
IEnumerable<string>	allowGroups	Allowed groups.
IEnumerable<int>	allowMembers	Allowed individual members.

Returns

Type	Description
Task<bool>	True or false if the currently logged in member is authorized

IsProtectedAsync(IEnumerable<string>)

Declaration

public virtual Task<IReadOnlyDictionary<string, bool>> IsProtectedAsync(IEnumerable<string> paths)

Parameters

Type	Name	Description
IEnumerable<string>	paths

Returns

Type	Description
Task<IReadOnlyDictionary<string, bool>>

IsProtectedAsync(string)

Check if a document object is protected by the "Protect Pages" functionality in umbraco

Declaration

public virtual Task<bool> IsProtectedAsync(string path)

Parameters

Type	Name	Description
string	path	The full path of the document object to check

Returns

Type	Description
Task<bool>	True if the document object is protected

Remarks

this is a cached call

MemberHasAccessAsync(IEnumerable<string>)

Checks if the current user has access to the paths

Declaration

public virtual Task<IReadOnlyDictionary<string, bool>> MemberHasAccessAsync(IEnumerable<string> paths)

Parameters

Type	Name	Description
IEnumerable<string>	paths

Returns

Type	Description
Task<IReadOnlyDictionary<string, bool>>

MemberHasAccessAsync(string)

Check if the current user has access to a document

Declaration

public virtual Task<bool> MemberHasAccessAsync(string path)

Parameters

Type	Name	Description
string	path	The full path of the document object to check

Returns

Type	Description
Task<bool>	True if the current user has access or if the current document isn't protected