View Source

Interface IUserGroupPresentationFactory

A factory for creating UserGroupResponseModel

Namespace: Umbraco.Cms.Api.Management.Factories

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public interface IUserGroupPresentationFactory

Methods

CreateAsync(IUserGroup)

Creates a UserGroupResponseModel based on a

Declaration

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

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

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

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

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 .