Table of Contents

Class HeadlessChannelApiKeysCreate

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

Headless channel api key create dialog.

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

Constructors

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

Initializes an instance of the HeadlessChannelApiKeysCreate class.

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

Parameters

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

Properties

ChannelID

Channel ID.

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

Property Value

int

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.

[PageCommand(Permission = "ManageHeadlessTokens")]
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 UI page.

public override Task ConfigurePage()

Returns

Task

FinalizeInfoObject(HeadlessTokenInfo, IFormFieldValueProvider, CancellationToken)

Allows to modify values of infoObject before validation and saving.

protected override Task FinalizeInfoObject(HeadlessTokenInfo infoObject, IFormFieldValueProvider fieldValueProvider, CancellationToken cancellationToken)

Parameters

infoObject HeadlessTokenInfo

Info object to be set.

fieldValueProvider IFormFieldValueProvider

Provider of form field values.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task

Submit(FormSubmissionCommandArguments)

Handles the form submit command.

[PageCommand(Permission = "ManageHeadlessTokens")]
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