Class SettingsDetails

Namespace

Kentico.Xperience.Admin.Base.UIPages

Assembly

Kentico.Xperience.Admin.Base.dll

Settings details page.

public sealed class SettingsDetails : SettingsDetailsPageBase, IPage

Inheritance

object

Page<SettingsDetailTemplateClientProperties>

SettingsDetailsPageBase

SettingsDetails

Implements

IPage

Inherited Members

SettingsDetailsPageBase.ComponentCommand(FormComponentCommandModel, CancellationToken)

SettingsDetailsPageBase.Save(SaveKeysArguments)

Page<SettingsDetailTemplateClientProperties>.ConfigurePage()

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

SettingsDetails(IInfoProvider<SettingsCategoryInfo>, IInfoProvider<ScheduledTaskConfigurationInfo>, IFormDataBinder, IFormComponentCommandInvoker, ILocalizationService, ISchedulingExecutor)

Initializes a new instance of the SettingsDetails class.

public SettingsDetails(IInfoProvider<SettingsCategoryInfo> settingsCategoryInfoProvider, IInfoProvider<ScheduledTaskConfigurationInfo> taskProvider, IFormDataBinder formDataBinder, IFormComponentCommandInvoker formComponentCommandInvoker, ILocalizationService localizationService, ISchedulingExecutor schedulingExecutor)

Parameters

settingsCategoryInfoProvider IInfoProvider<SettingsCategoryInfo>

taskProvider IInfoProvider<ScheduledTaskConfigurationInfo>

formDataBinder IFormDataBinder

formComponentCommandInvoker IFormComponentCommandInvoker

localizationService ILocalizationService

schedulingExecutor ISchedulingExecutor

Properties

CategoryId

Id of selected node in settings tree.

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

Property Value

int

Methods

ConfigureTemplateProperties(SettingsDetailTemplateClientProperties)

Gets the object representing client side template properties.

public override Task<SettingsDetailTemplateClientProperties> ConfigureTemplateProperties(SettingsDetailTemplateClientProperties properties)

Parameters

properties SettingsDetailTemplateClientProperties

Initialized properties object.

Returns

Task<SettingsDetailTemplateClientProperties>

ExecuteLicenseReporterTask(CancellationToken)

Manually executes the license reporter task.

[PageCommand(Permission = "Update")]
public Task<ICommandResponse<CalloutButtonStatusCommandResponse>> ExecuteLicenseReporterTask(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<CalloutButtonStatusCommandResponse>>

ValidatePage()

Validates the page state prior invocation of the ConfigurePage() method.

public override Task<PageValidationResult> ValidatePage()

Returns

Task<PageValidationResult>