View Source

Class UserGroupPresentationFactory

A factory for creating UserGroupResponseModel

Inheritance

System.Object

Namespace: Umbraco.Cms.Api.Management.Factories

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public class UserGroupPresentationFactory : IUserGroupPresentationFactory

Constructors

UserGroupPresentationFactory(IEntityService, IShortStringHelper, ILanguageService, IPermissionPresentationFactory)

Declaration

public UserGroupPresentationFactory(IEntityService entityService, IShortStringHelper shortStringHelper, ILanguageService languageService, IPermissionPresentationFactory permissionPresentationFactory)

Parameters

Type	Name	Description
IEntityService	entityService
IShortStringHelper	shortStringHelper
ILanguageService	languageService
IPermissionPresentationFactory	permissionPresentationFactory

UserGroupPresentationFactory(IEntityService, IShortStringHelper, ILanguageService, IPermissionPresentationFactory, ILogger<UserGroupPresentationFactory>)

Declaration

public UserGroupPresentationFactory(IEntityService entityService, IShortStringHelper shortStringHelper, ILanguageService languageService, IPermissionPresentationFactory permissionPresentationFactory, ILogger<UserGroupPresentationFactory> logger)

Parameters

Type	Name	Description
IEntityService	entityService
IShortStringHelper	shortStringHelper
ILanguageService	languageService
IPermissionPresentationFactory	permissionPresentationFactory
ILogger<UserGroupPresentationFactory>	logger

Methods

CreateAsync(IReadOnlyUserGroup)

Declaration

public async Task<UserGroupResponseModel> CreateAsync(IReadOnlyUserGroup userGroup)

Parameters

Type	Name	Description
IReadOnlyUserGroup	userGroup

Returns

Type	Description
Task<UserGroupResponseModel>

CreateAsync(IUserGroup)

Creates a UserGroupResponseModel based on a

Declaration

public async Task<UserGroupResponseModel> CreateAsync(IUserGroup userGroup)

Parameters

Type	Name	Description
IUserGroup	userGroup

Returns

Type	Description
Task<UserGroupResponseModel>

CreateAsync(CreateUserGroupRequestModel)

Creates an based on a CreateUserGroupRequestModel

Declaration

public async Task<Attempt<IUserGroup, UserGroupOperationStatus>> CreateAsync(CreateUserGroupRequestModel requestModel)

Parameters

Type	Name	Description
CreateUserGroupRequestModel	requestModel

Returns

Type	Description
Task<Attempt<IUserGroup, UserGroupOperationStatus>>	An attempt indicating if the operation was a success as well as a more detailed .

CreateMultipleAsync(IEnumerable<IReadOnlyUserGroup>)

Creates multiple UserGroupResponseModel base on multiple

Declaration

public async Task<IEnumerable<UserGroupResponseModel>> CreateMultipleAsync(IEnumerable<IReadOnlyUserGroup> userGroups)

Parameters

Type	Name	Description
IEnumerable<IReadOnlyUserGroup>	userGroups

Returns

Type	Description
Task<IEnumerable<UserGroupResponseModel>>

CreateMultipleAsync(IEnumerable<IUserGroup>)

Creates multiple UserGroupResponseModel base on multiple

Declaration

public async Task<IEnumerable<UserGroupResponseModel>> CreateMultipleAsync(IEnumerable<IUserGroup> userGroups)

Parameters

Type	Name	Description
IEnumerable<IUserGroup>	userGroups

Returns

Type	Description
Task<IEnumerable<UserGroupResponseModel>>

UpdateAsync(IUserGroup, UpdateUserGroupRequestModel)

Converts the values of an update model to fit with the existing backoffice implementations, and maps it to an existing user group.

Declaration

public async Task<Attempt<IUserGroup, UserGroupOperationStatus>> UpdateAsync(IUserGroup current, UpdateUserGroupRequestModel request)

Parameters

Type	Name	Description
IUserGroup	current	Existing user group to map to.
UpdateUserGroupRequestModel	request	Update model containing the new values.

Returns

Type	Description
Task<Attempt<IUserGroup, UserGroupOperationStatus>>	An attempt indicating if the operation was a success as well as a more detailed .