Class HeadlessInformation

Namespace

Kentico.Xperience.Admin.Headless.UIPages

Assembly

Kentico.Xperience.Admin.Headless.dll

Page information properties page.

public sealed class HeadlessInformation : ModelEditPage<HeadlessInformationModel>, IPage

Inheritance

object

Page<EditTemplateClientProperties>

EditPageBase

ModelEditPage<HeadlessInformationModel>

HeadlessInformation

Implements

IPage

Inherited Members

ModelEditPage<HeadlessInformationModel>.Change(FormChangeCommandArguments)

ModelEditPage<HeadlessInformationModel>.ConfigureTemplateProperties(EditTemplateClientProperties)

ModelEditPage<HeadlessInformationModel>.ValidatePage()

EditPageBase.PageConfiguration

EditPageBase.ComponentCommand(FormComponentCommandModel, CancellationToken)

EditPageBase.Submit(FormSubmissionCommandArguments)

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

HeadlessInformation(IFormItemCollectionProvider, IFormDataBinder, IUserInfoProvider, IAuthenticatedUserAccessor, IHeadlessItemManagerFactory, IInfoProvider<ContentItemInfo>, IInfoProvider<HeadlessItemInfo>, IContentLanguageRetriever)

Initializes a new instance of the HeadlessInformation class.

public HeadlessInformation(IFormItemCollectionProvider formItemCollectionProvider, IFormDataBinder formDataBinder, IUserInfoProvider userInfoProvider, IAuthenticatedUserAccessor authenticatedUserAccessor, IHeadlessItemManagerFactory headlessItemManagerFactory, IInfoProvider<ContentItemInfo> contentItemProvider, IInfoProvider<HeadlessItemInfo> headlessItemInfoProvider, IContentLanguageRetriever contentLanguageRetriever)

Parameters

formItemCollectionProvider IFormItemCollectionProvider

formDataBinder IFormDataBinder

userInfoProvider IUserInfoProvider

authenticatedUserAccessor IAuthenticatedUserAccessor

headlessItemManagerFactory IHeadlessItemManagerFactory

contentItemProvider IInfoProvider<ContentItemInfo>

headlessItemInfoProvider IInfoProvider<HeadlessItemInfo>

contentLanguageRetriever IContentLanguageRetriever

Properties

ApplicationIdentifier

Application identifier.

[PageParameter(typeof(HeadlessChannelApplicationModelBinder), typeof(HeadlessChannelApplication))]
public HeadlessChannelApplicationUrlIdentifier ApplicationIdentifier { get; set; }

Property Value

HeadlessChannelApplicationUrlIdentifier

ContentLanguageIdentifier

Content language identifier.

[PageParameter(typeof(ContentLanguageModelBinder), typeof(HeadlessChannelContentLanguage))]
public ContentLanguageUrlIdentifier ContentLanguageIdentifier { get; set; }

Property Value

ContentLanguageUrlIdentifier

HeadlessItemID

Headless item identifier.

[PageParameter(typeof(IntPageModelBinder), typeof(HeadlessEditLayout))]
public int HeadlessItemID { get; set; }

Property Value

int

Model

Gets edited model that represents the form.

protected override HeadlessInformationModel Model { get; }

Property Value

HeadlessInformationModel

SuccessMessageKey

Gets or sets the success message displayed after submitting the form.

protected override string SuccessMessageKey { get; }

Property Value

string

Methods

ConfigurePage()

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

public override Task ConfigurePage()

Returns

Task

GetFormItems()

Examines properties of Model and returns corresponding IFormItems.

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

Returns

Task<ICollection<IFormItem>>

Remarks

Override the method in case when additional set-up of form components is required.

ProcessFormData(HeadlessInformationModel, ICollection<IFormItem>)

Stores the model and creates a response for the Submit(FormSubmissionCommandArguments) command.

protected override Task<ICommandResponse> ProcessFormData(HeadlessInformationModel model, ICollection<IFormItem> formItems)

Parameters

model HeadlessInformationModel

Model to be stored.

formItems ICollection<IFormItem>

Form items with bound component values.

Returns

Task<ICommandResponse>

The response to be used for the Submit(FormSubmissionCommandArguments) command.