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 |
Returns
| Type | Description |
|---|---|
| IPublishedContent |
GetCurrentMemberAsync()
Returns the currently logged in member if there is one, else returns null
Declaration
Task<MemberIdentityUser> GetCurrentMemberAsync()Returns
| Type | Description |
|---|---|
| Task<MemberIdentityUser> |
IsLoggedIn()
Check if a member is logged in
Declaration
bool IsLoggedIn()Returns
| Type | Description |
|---|---|
| System.Boolean |
IsMemberAuthorizedAsync(Nullable<IEnumerable<String>>, Nullable<IEnumerable<String>>, Nullable<IEnumerable<Int32>>)
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 |
|---|---|---|
| System.Nullable<IEnumerable<System.String>> | allowTypes | Allowed types. |
| System.Nullable<IEnumerable<System.String>> | allowGroups | Allowed groups. |
| System.Nullable<IEnumerable<System.Int32>> | allowMembers | Allowed individual members. |
Returns
| Type | Description |
|---|---|
| Task<System.Boolean> | True or false if the currently logged in member is authorized |
IsProtectedAsync(IEnumerable<String>)
Declaration
Task<IReadOnlyDictionary<string, bool>> IsProtectedAsync(IEnumerable<string> paths)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<System.String> | paths |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyDictionary<System.String, System.Boolean>> |
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 |
|---|---|---|
| System.String | path | The full path of the document object to check |
Returns
| Type | Description |
|---|---|
| Task<System.Boolean> | 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<System.String> | paths |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyDictionary<System.String, System.Boolean>> |
MemberHasAccessAsync(String)
Check if the current user has access to a document
Declaration
Task<bool> MemberHasAccessAsync(string path)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | The full path of the document object to check |
Returns
| Type | Description |
|---|---|
| Task<System.Boolean> | True if the current user has access or if the current document isn't protected |