Table of Contents

Class HeadlessChannelApiKeysGenerate

Namespace
Kentico.Xperience.Admin.Headless.UIPages
Assembly
Kentico.Xperience.Admin.Headless.dll

Headless channel API key edit page.

[UINavigation(false)]
[UIEvaluatePermission("ManageHeadlessTokens")]
public sealed class HeadlessChannelApiKeysGenerate : InfoEditPage<HeadlessTokenInfo>, IPage
Inheritance
object
HeadlessChannelApiKeysGenerate
Implements
Inherited Members
Extension Methods

Constructors

HeadlessChannelApiKeysGenerate(IFormComponentMapper, IFormDataBinder, IHeadlessTokenManagerFactory, IAuthenticatedUserAccessor, IPageLinkGenerator, IInfoProvider<HeadlessChannelInfo>) 

public HeadlessChannelApiKeysGenerate(IFormComponentMapper formComponentMapper, IFormDataBinder formDataBinder, IHeadlessTokenManagerFactory headlessTokenManagerFactory, IAuthenticatedUserAccessor authenticatedUserAccessor, IPageLinkGenerator pageLinkGenerator, IInfoProvider<HeadlessChannelInfo> headlessChannelInfoProvider)

Parameters

formComponentMapper IFormComponentMapper
formDataBinder IFormDataBinder
headlessTokenManagerFactory IHeadlessTokenManagerFactory
authenticatedUserAccessor IAuthenticatedUserAccessor
pageLinkGenerator IPageLinkGenerator
headlessChannelInfoProvider IInfoProvider<HeadlessChannelInfo>

Properties

ObjectId

ID of the object.

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

Property Value

int

RefetchAll

Indicates whether to refetch all templates on edit.

protected override bool RefetchAll { get; }

Property Value

bool

Methods

Change(FormChangeCommandArguments)

Handles the form change command. The command is invoked whenever visibility conditions of the form need to be reevaluated to re-render the form.

public override Task<ICommandResponse<FormChangeResult>> Change(FormChangeCommandArguments args)

Parameters

args FormChangeCommandArguments

Form change arguments.

Returns

Task<ICommandResponse<FormChangeResult>>

Returns the form change result.

ConfigurePage()

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

public override Task ConfigurePage()

Returns

Task

GetDefaultUIFormName()

Returns default UI form name.

protected override string GetDefaultUIFormName()

Returns

string

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.

Submit(FormSubmissionCommandArguments)

Handles the form submit command.

public override Task<ICommandResponse> Submit(FormSubmissionCommandArguments args)

Parameters

args FormSubmissionCommandArguments

Form submission arguments.

Returns

Task<ICommandResponse>

Returns the form submission result.

Remarks

The default implementation calls the SubmitInternal(FormSubmissionCommandArguments, ICollection<IFormItem>, IFormFieldValueProvider) method.

See Also

SubmitInternal(FormSubmissionCommandArguments, ICollection<IFormItem>, IFormFieldValueProvider)

Handles the internal specific processing of form submit command.

protected override Task<ICommandResponse> SubmitInternal(FormSubmissionCommandArguments args, ICollection<IFormItem> items, IFormFieldValueProvider formFieldValueProvider)

Parameters

args FormSubmissionCommandArguments

Form submission arguments.

items ICollection<IFormItem>

Form items with bound component values.

formFieldValueProvider IFormFieldValueProvider

Provider of form field values.

Returns

Task<ICommandResponse>

Returns the form submission result.

Remarks

This method is called by the default implementation of the Submit(FormSubmissionCommandArguments) method.

See Also