Interface IMemberManager
The user manager for members
Namespace: Umbraco.Cms.Core.Security
Assembly: Umbraco.Infrastructure.dll
Syntax
public interface IMemberManager : IUmbracoUserManager<MemberIdentityUser>Methods
View SourceAsPublishedMember(MemberIdentityUser)
Returns the IPublishedContent instance for the specified MemberIdentityUser
Declaration
IPublishedContent? AsPublishedMember(MemberIdentityUser user)Parameters
| Type | Name | Description |
|---|---|---|
| MemberIdentityUser | user | The member identity user. |
Returns
| Type | Description |
|---|---|
| IPublishedContent | The published content for the member, or null if not found. |
GetCurrentMemberAsync()
Returns the currently logged in member if there is one, else returns null
Declaration
Task<MemberIdentityUser?> GetCurrentMemberAsync()Returns
| Type | Description |
|---|---|
| Task<MemberIdentityUser> | The current member, or null if not logged in. |
IsLoggedIn()
Check if a member is logged in
Declaration
bool IsLoggedIn()Returns
| Type | Description |
|---|---|
| bool | True if a member is logged in. |
IsMemberAuthorizedAsync(IEnumerable<string>?, IEnumerable<string>?, IEnumerable<int>?)
Checks if the current member is authorized based on the parameters provided.
Declaration
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>)
Checks if the document objects specified by their paths are protected by the "Protect Pages" functionality in Umbraco.
Declaration
Task<IReadOnlyDictionary<string, bool>> IsProtectedAsync(IEnumerable<string> paths)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<string> | paths | The full paths of the document objects to check. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyDictionary<string, bool>> | A task that represents the asynchronous operation. The task result contains a read-only dictionary mapping each document path to a boolean value indicating whether the corresponding document object is protected. |
IsProtectedAsync(string)
Check if a document object is protected by the "Protect Pages" functionality in umbraco
Declaration
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 |
MemberHasAccessAsync(IEnumerable<string>)
Checks if the current user has access to the paths
Declaration
Task<IReadOnlyDictionary<string, bool>> MemberHasAccessAsync(IEnumerable<string> paths)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<string> | paths | The document paths to check access for. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyDictionary<string, bool>> | A dictionary mapping each path to whether the member has access. |
MemberHasAccessAsync(string)
Check if the current user has access to a document
Declaration
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 |