Interface IMemberGroupService

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IMemberGroupService : IService

Methods

View Source

CreateAsync(IMemberGroup)

Creates a new IMemberGroup object

Declaration

Task<Attempt<IMemberGroup?, MemberGroupOperationStatus>> CreateAsync(IMemberGroup memberGroup)

Parameters

Type	Name	Description
IMemberGroup	memberGroup	IMemberGroup to create

Returns

Type	Description
Task<Attempt<IMemberGroup, MemberGroupOperationStatus>>	An attempt with a status of whether the operation was successful or not, and the created object if it succeeded.

View Source

Delete(IMemberGroup)

Declaration

[Obsolete("Please use the asynchronous counterpart. Scheduled for removal in v15.")]
void Delete(IMemberGroup memberGroup)

Parameters

Type	Name	Description
IMemberGroup	memberGroup

View Source

DeleteAsync(Guid)

Deletes a IMemberGroup by removing it and its usages from the db

Declaration

Task<Attempt<IMemberGroup?, MemberGroupOperationStatus>> DeleteAsync(Guid key)

Parameters

Type	Name	Description
Guid	key	The key of the IMemberGroup to delete

Returns

Type	Description
Task<Attempt<IMemberGroup, MemberGroupOperationStatus>>

View Source

GetAll()

Declaration

[Obsolete("Please use the asynchronous counterpart. Scheduled for removal in v15.")]
IEnumerable<IMemberGroup> GetAll()

Returns

Type	Description
IEnumerable<IMemberGroup>

View Source

GetAllAsync()

Gets all member groups

Declaration

Task<IEnumerable<IMemberGroup>> GetAllAsync()

Returns

Type	Description
Task<IEnumerable<IMemberGroup>>	An enumerable list of IMemberGroup objects.

View Source

GetAsync(Guid)

Get a member group by key.

Declaration

Task<IMemberGroup?> GetAsync(Guid key)

Parameters

Type	Name	Description
Guid	key	System.Guid of the member group to get.

Returns

Type	Description
Task<IMemberGroup>	A IMemberGroup object.

View Source

GetById(Guid)

Declaration

[Obsolete("Please use the asynchronous counterpart. Scheduled for removal in v15.")]
IMemberGroup? GetById(Guid id)

Parameters

Type	Name	Description
Guid	id

Returns

Type	Description
IMemberGroup

View Source

GetById(int)

Declaration

[Obsolete("Please use Guid instead of Int id. Scheduled for removal in v15.")]
IMemberGroup? GetById(int id)

Parameters

Type	Name	Description
int	id

Returns

Type	Description
IMemberGroup

View Source

GetByIds(IEnumerable<int>)

Declaration

[Obsolete("Please use the asynchronous counterpart. Scheduled for removal in v15.")]
IEnumerable<IMemberGroup> GetByIds(IEnumerable<int> ids)

Parameters

Type	Name	Description
IEnumerable<int>	ids

Returns

Type	Description
IEnumerable<IMemberGroup>

View Source

GetByIdsAsync(IEnumerable<int>)

Gets a list of member groups with the given ids.

Declaration

Task<IEnumerable<IMemberGroup>> GetByIdsAsync(IEnumerable<int> ids)

Parameters

Type	Name	Description
IEnumerable<int>	ids	An enumerable list of int ids, to get the member groups by.

Returns

Type	Description
Task<IEnumerable<IMemberGroup>>	An enumerable list of IMemberGroup objects.

View Source

GetByName(string?)

Declaration

IMemberGroup? GetByName(string? name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
IMemberGroup

View Source

GetByNameAsync(string)

Get a member group by name.

Declaration

Task<IMemberGroup?> GetByNameAsync(string name)

Parameters

Type	Name	Description
string	name	Name of the member group to get.

Returns

Type	Description
Task<IMemberGroup>	A IMemberGroup object.

View Source

Save(IMemberGroup)

Declaration

[Obsolete("Please use the respective CreateAsync/UpdateAsync for you save operations. Scheduled for removal in v15.")]
void Save(IMemberGroup memberGroup)

Parameters

Type	Name	Description
IMemberGroup	memberGroup

View Source

UpdateAsync(IMemberGroup)

Updates IMemberGroup object

Declaration

Task<Attempt<IMemberGroup?, MemberGroupOperationStatus>> UpdateAsync(IMemberGroup memberGroup)

Parameters

Type	Name	Description
IMemberGroup	memberGroup	IMemberGroup to create

Returns

Type	Description
Task<Attempt<IMemberGroup, MemberGroupOperationStatus>>	An attempt with a status of whether the operation was successful or not, and the object.