Defines the MemberService, which is an easy access to operations involving (umbraco) members.
Namespace: Umbraco.Cms.Core.Services Assembly: Umbraco.Core.dll Syntaxpublic interface IMemberService : IMembershipMemberService, IMembershipMemberService<IMember>, IMembershipRoleService<IMember>, IContentServiceBase<IMember>, IContentServiceBase, IService
Methods View Source Count(String)
Gets the count of Members by an optional MemberType alias
Declarationint Count(string memberTypeAlias = null)
Parameters Type Name Description System.String memberTypeAlias
Optional alias for the MemberType when counting number of Members
Returns Type Description System.Int32System.Int32 with number of Members
View Source CreateMember(String, String, String, String)Creates an IMember object without persisting it
DeclarationIMember CreateMember(string username, string email, string name, string memberTypeAlias)
Parameters Type Name Description System.String username
Username of the Member to create
System.String emailEmail of the Member to create
System.String nameName of the Member to create
System.String memberTypeAliasAlias of the MemberType the Member should be based on
Returns View Source CreateMember(String, String, String, IMemberType)Creates an IMember object without persisting it
DeclarationIMember CreateMember(string username, string email, string name, IMemberType memberType)
Parameters Type Name Description System.String username
Username of the Member to create
System.String emailEmail of the Member to create
System.String nameName of the Member to create
IMemberType memberTypeMemberType the Member should be based on
Returns View Source CreateMemberWithIdentity(String, String, String)Creates and persists a Member
Declarationvirtual IMember CreateMemberWithIdentity(string username, string email, string memberTypeAlias)
Parameters Type Name Description System.String username
Username of the Member to create
System.String emailEmail of the Member to create
System.String memberTypeAliasAlias of the MemberType the Member should be based on
Returns View Source CreateMemberWithIdentity(String, String, String, Boolean)Creates and persists a Member
Declarationvirtual IMember CreateMemberWithIdentity(string username, string email, string memberTypeAlias, bool isApproved)
Parameters Type Name Description System.String username
Username of the Member to create
System.String emailEmail of the Member to create
System.String memberTypeAliasAlias of the MemberType the Member should be based on
System.Boolean isApprovedWhether the member is approved or not
Returns View Source CreateMemberWithIdentity(String, String, String, String)Creates and persists a Member
DeclarationIMember CreateMemberWithIdentity(string username, string email, string name, string memberTypeAlias)
Parameters Type Name Description System.String username
Username of the Member to create
System.String emailEmail of the Member to create
System.String nameName of the Member to create
System.String memberTypeAliasAlias of the MemberType the Member should be based on
Returns View Source CreateMemberWithIdentity(String, String, String, String, Boolean)Creates and persists a Member
Declarationvirtual IMember CreateMemberWithIdentity(string username, string email, string name, string memberTypeAlias, bool isApproved)
Parameters Type Name Description System.String username
Username of the Member to create
System.String emailEmail of the Member to create
System.String nameName of the Member to create
System.String memberTypeAliasAlias of the MemberType the Member should be based on
System.Boolean isApprovedWhether the member is approved or not
Returns View Source CreateMemberWithIdentity(String, String, String, IMemberType)Creates and persists a Member
DeclarationIMember CreateMemberWithIdentity(string username, string email, string name, IMemberType memberType)
Parameters Type Name Description System.String username
Username of the Member to create
System.String emailEmail of the Member to create
System.String nameName of the Member to create
IMemberType memberTypeMemberType the Member should be based on
Returns View Source Delete(IMember, Int32)Permanently deletes an IMember object
DeclarationAttempt<OperationResult> Delete(IMember member, int userId = -1)
Parameters Type Name Description IMember member
The IMember to delete
System.Int32 userIdId of the User deleting the Member
Returns View Source DeleteMembersOfType(Int32)Delete Members of the specified MemberType id
Declarationvoid DeleteMembersOfType(int memberTypeId)
Parameters Type Name Description System.Int32 memberTypeId
Id of the MemberType
View Source Exists(Int32)Checks if a Member with the id exists
Declaration Parameters Type Name Description System.Int32 idId of the Member
Returns Type Description System.BooleanTrue
if the Member exists otherwise False
Task<PagedModel<IMember>> FilterAsync(MemberFilter memberFilter, string orderBy = "username", Direction orderDirection = Direction.Ascending, int skip = 0, int take = 100)
Parameters Type Name Description MemberFilter memberFilter System.String orderBy Direction orderDirection System.Int32 skip System.Int32 take Returns View Source FindMembersByDisplayName(String, Int64, Int32, out Int64, StringPropertyMatchType)
Finds Members based on their display name
DeclarationIEnumerable<IMember> FindMembersByDisplayName(string displayNameToMatch, long pageIndex, int pageSize, out long totalRecords, StringPropertyMatchType matchType = StringPropertyMatchType.StartsWith)
Parameters Type Name Description System.String displayNameToMatch
Display name to match
System.Int64 pageIndexCurrent page index
System.Int32 pageSizeSize of the page
System.Int64 totalRecordsTotal number of records found (out)
StringPropertyMatchType matchTypeThe type of match to make as StringPropertyMatchType. Default is StartsWith
Returns Type Description IEnumerable<IMember> View Source GetAll(Int32, Int32, out Int64, String, Direction, String, String)Gets a list of paged IMember objects
Declarationvirtual IEnumerable<IMember> GetAll(int skip, int take, out long totalRecords, string orderBy, Direction orderDirection, string memberTypeAlias = null, string filter = "")
Parameters Type Name Description System.Int32 skip
Amount to skip.
System.Int32 takeAmount to take.
System.Int64 totalRecordsTotal number of records found (out)
System.String orderByField to order by
Direction orderDirectionDirection to order by
System.String memberTypeAlias System.String filterSearch text filter
Returns Type Description IEnumerable<IMember> View Source GetAll(Int64, Int32, out Int64, String, Direction, Boolean, String, String)Gets a list of paged IMember objects
DeclarationIEnumerable<IMember> GetAll(long pageIndex, int pageSize, out long totalRecords, string orderBy, Direction orderDirection, bool orderBySystemField, string memberTypeAlias, string filter)
Parameters Type Name Description System.Int64 pageIndex
Current page index
System.Int32 pageSizeSize of the page
System.Int64 totalRecordsTotal number of records found (out)
System.String orderByField to order by
Direction orderDirectionDirection to order by
System.Boolean orderBySystemFieldFlag to indicate when ordering by system field
System.String memberTypeAlias System.String filterSearch text filter
Returns Type Description IEnumerable<IMember> View Source GetAll(Int64, Int32, out Int64, String, Direction, String, String)Gets a list of paged IMember objects
DeclarationIEnumerable<IMember> GetAll(long pageIndex, int pageSize, out long totalRecords, string orderBy, Direction orderDirection, string memberTypeAlias = null, string filter = "")
Parameters Type Name Description System.Int64 pageIndex
Current page index
System.Int32 pageSizeSize of the page
System.Int64 totalRecordsTotal number of records found (out)
System.String orderByField to order by
Direction orderDirectionDirection to order by
System.String memberTypeAlias System.String filterSearch text filter
Returns Type Description IEnumerable<IMember> View Source GetAllMembers(Int32[])Gets all Members with the ids specified
DeclarationIEnumerable<IMember> GetAllMembers(params int[] ids)
Parameters Type Name Description System.Int32[] ids
Optional list of Member Ids
Returns Type Description IEnumerable<IMember> View Source GetById(Int32)Gets a Member by its integer id
Declaration Parameters Type Name Description System.Int32 idSystem.Int32 Id
Returns View Source GetByKey(Guid)Gets a Member by the unique key
DeclarationIMember GetByKey(Guid id)
Parameters Type Name Description Guid id
Id
Returns View Source GetByKeysAsync(Guid[])Gets IMember objects by Ids
DeclarationTask<IEnumerable<IMember>> GetByKeysAsync(params Guid[] ids)
Parameters Type Name Description Guid[] ids
Ids of the Member to retrieve
Returns View Source GetMembersByEmail(String)Get an list of IMember for all members with the specified email.
Declarationvirtual IEnumerable<IMember> GetMembersByEmail(string email)
Parameters Type Name Description System.String email
Email to use for retrieval
Returns Type Description IEnumerable<IMember> View Source GetMembersByGroup(String)Gets all Members within the specified MemberGroup name
DeclarationIEnumerable<IMember> GetMembersByGroup(string memberGroupName)
Parameters Type Name Description System.String memberGroupName
Name of the MemberGroup
Returns Type Description IEnumerable<IMember> View Source GetMembersByMemberType(Int32)Gets all Members for the MemberType id
DeclarationIEnumerable<IMember> GetMembersByMemberType(int memberTypeId)
Parameters Type Name Description System.Int32 memberTypeId
Id of the MemberType
Returns Type Description IEnumerable<IMember> View Source GetMembersByMemberType(String)Gets all Members for the specified MemberType alias
DeclarationIEnumerable<IMember> GetMembersByMemberType(string memberTypeAlias)
Parameters Type Name Description System.String memberTypeAlias
Alias of the MemberType
Returns Type Description IEnumerable<IMember> View Source GetMembersByPropertyValue(String, DateTime, ValuePropertyMatchType)Gets a list of Members based on a property search
DeclarationIEnumerable<IMember>? GetMembersByPropertyValue(string propertyTypeAlias, DateTime value, ValuePropertyMatchType matchType = ValuePropertyMatchType.Exact)
Parameters Returns Type Description System.Nullable<IEnumerable<IMember>> View Source GetMembersByPropertyValue(String, Boolean)
Gets a list of Members based on a property search
DeclarationIEnumerable<IMember>? GetMembersByPropertyValue(string propertyTypeAlias, bool value)
Parameters Type Name Description System.String propertyTypeAlias
Alias of the PropertyType to search for
System.Boolean valueSystem.Boolean Value to match
Returns Type Description System.Nullable<IEnumerable<IMember>> View Source GetMembersByPropertyValue(String, Int32, ValuePropertyMatchType)Gets a list of Members based on a property search
DeclarationIEnumerable<IMember>? GetMembersByPropertyValue(string propertyTypeAlias, int value, ValuePropertyMatchType matchType = ValuePropertyMatchType.Exact)
Parameters Returns Type Description System.Nullable<IEnumerable<IMember>> View Source GetMembersByPropertyValue(String, String, StringPropertyMatchType)
Gets a list of Members based on a property search
DeclarationIEnumerable<IMember>? GetMembersByPropertyValue(string propertyTypeAlias, string value, StringPropertyMatchType matchType = StringPropertyMatchType.Exact)
Parameters Returns Type Description System.Nullable<IEnumerable<IMember>> View Source Save(IEnumerable<IMember>, Int32)
Saves a list of IMember objects
DeclarationAttempt<OperationResult> Save(IEnumerable<IMember> members, int userId = -1)
Parameters Type Name Description IEnumerable<IMember> members
Collection of IMember to save
System.Int32 userIdId of the User saving the Members
Returns View Source Save(IMember, Int32)Saves a single IMember object
DeclarationAttempt<OperationResult> Save(IMember media, int userId = -1)
Parameters Type Name Description IMember media
The IMember to save
System.Int32 userIdId of the User saving the Member
Returns View Source Save(IMember, PublishNotificationSaveOptions, Int32)Saves an IMembershipUser
Declarationvirtual Attempt<OperationResult> Save(IMember member, PublishNotificationSaveOptions publishNotificationSaveOptions, int userId = -1)
Parameters Returns
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4