Class UserEdit

Namespace

Kentico.Xperience.Admin.Base.UIPages

Assembly

Kentico.Xperience.Admin.Base.dll

General tab of the user's edit page.

public sealed class UserEdit : InfoEditPage<UserInfo>, IPage

Inheritance

object

Page<EditTemplateClientProperties>

EditPageBase

InfoEditPageBase<UserInfo>

InfoEditPage<UserInfo>

UserEdit

Implements

IPage

Inherited Members

InfoEditPageBase<UserInfo>.ConfigureTemplateProperties(EditTemplateClientProperties)

InfoEditPageBase<UserInfo>.ValidatePage()

InfoEditPageBase<UserInfo>.RegisterMacroField(MacroField)

EditPageBase.PageConfiguration

EditPageBase.ComponentCommand(FormComponentCommandModel, CancellationToken)

EditPageBase.Change(FormChangeCommandArguments)

EditPageBase.Submit(FormSubmissionCommandArguments)

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

UserEdit(IFormComponentMapper, IFormDataBinder, IServiceProvider, IRoleInfoProvider, IUserRoleInfoProvider, IAuthenticatedUserAccessor, AdminSignInManager, IPageLinkGenerator, IOptions<AdminExternalAuthenticationProviderOptions>)

Initializes a new instance of the UserEdit class.

public UserEdit(IFormComponentMapper formComponentMapper, IFormDataBinder formDataBinder, IServiceProvider services, IRoleInfoProvider roleProvider, IUserRoleInfoProvider userRoleProvider, IAuthenticatedUserAccessor authenticatedUserAccessor, AdminSignInManager signInManager, IPageLinkGenerator pageLinkGenerator, IOptions<AdminExternalAuthenticationProviderOptions> adminExternalAuthenticationProviderOptionsAcessor)

Parameters

formComponentMapper IFormComponentMapper

formDataBinder IFormDataBinder

services IServiceProvider

roleProvider IRoleInfoProvider

userRoleProvider IUserRoleInfoProvider

authenticatedUserAccessor IAuthenticatedUserAccessor

signInManager AdminSignInManager

pageLinkGenerator IPageLinkGenerator

adminExternalAuthenticationProviderOptionsAcessor IOptions<AdminExternalAuthenticationProviderOptions>

Properties

ObjectId

ID of the user.

[PageParameter(typeof(IntPageModelBinder))]
public override int ObjectId { get; set; }

Property Value

int

Methods

ConfigurePage()

Set up page's configuration. Configures the submit action.

public override Task ConfigurePage()

Returns

Task

GetFormItems()

Prepares form items for editing object of the specified ObjectType.

protected override Task<ICollection<IFormItem>> GetFormItems()

Returns

Task<ICollection<IFormItem>>

Returns the collection of form items.

GetSubmitSuccessResponse(UserInfo, ICollection<IFormItem>)

Response that has to be returned after successful form submission.

protected override Task<ICommandResponse> GetSubmitSuccessResponse(UserInfo savedInfoObject, ICollection<IFormItem> items)

Parameters

savedInfoObject UserInfo

Object info after persisting.

items ICollection<IFormItem>

Collection with updated form items.

Returns

Task<ICommandResponse>

ResetAuthenticatorKey()

Resets the authenticator key.

public Task<ICommandResponse> ResetAuthenticatorKey()

Returns

Task<ICommandResponse>

SetFormData(UserInfo, IFormFieldValueProvider)

Sets the infoObject.

protected override Task SetFormData(UserInfo infoObject, IFormFieldValueProvider fieldValueProvider)

Parameters

infoObject UserInfo

Info object to be set.

fieldValueProvider IFormFieldValueProvider

Provider of form field values.

Returns

Task