Table of Contents

Class PersonalDataManagementPage

Namespace
Kentico.Xperience.Admin.DigitalMarketing
Assembly
Kentico.Xperience.Admin.DigitalMarketing.dll

Base page for data protection pages providing personal data.

public abstract class PersonalDataManagementPage : Page<PersonalDataManagementTemplateClientProperties>, IPage
Inheritance
object
PersonalDataManagementPage
Implements
Derived
Inherited Members
Extension Methods

Constructors

PersonalDataManagementPage(IFormItemCollectionProvider, IOptions<CustomerDataPlatformOptions>, IFormDataBinder)

Initializes an instance of the PersonalDataManagementPage class.

protected PersonalDataManagementPage(IFormItemCollectionProvider formItemCollectionProvider, IOptions<CustomerDataPlatformOptions> customerDataPlatformOptions, IFormDataBinder formDataBinder)

Parameters

formItemCollectionProvider IFormItemCollectionProvider

Provider that retrieves collection of form items based on a model object.

customerDataPlatformOptions IOptions<CustomerDataPlatformOptions>

Customer data platform options.

formDataBinder IFormDataBinder

Form data binder.

Fields

customerDataPlatformOptions

Customer data management options.

protected readonly IOptions<CustomerDataPlatformOptions> customerDataPlatformOptions

Field Value

IOptions<CustomerDataPlatformOptions>

formDataBinder

Form data binder.

protected readonly IFormDataBinder formDataBinder

Field Value

IFormDataBinder

formItemCollectionProvider

Provider that retrieves collection of form items based on a model object.

protected readonly IFormItemCollectionProvider formItemCollectionProvider

Field Value

IFormItemCollectionProvider

Properties

OutputFormat

Personal data output format. For possible values see PersonalDataFormat class.

protected abstract string OutputFormat { get; }

Property Value

string

PageConfiguration

Page configuration.

public PersonalDataManagementPageConfiguration PageConfiguration { get; set; }

Property Value

PersonalDataManagementPageConfiguration

Methods

Change(FormChangeCommandArguments)

Handles the form change command for personal data management forms. The command is invoked whenever visibility conditions or form configurators need to be reevaluated.

[PageCommand]
public Task<ICommandResponse<DataErasureDialogConfiguration>> Change(FormChangeCommandArguments args)

Parameters

args FormChangeCommandArguments

Form change arguments.

Returns

Task<ICommandResponse<DataErasureDialogConfiguration>>

Returns the form change result with updated form items.

CheckRegisteredCollectorsAndErasers()

Checks if collectors and erasers are registerd.

protected virtual void CheckRegisteredCollectorsAndErasers()

ConfigurePage()

Allows configure and share page specific values prior invocation of the ConfigureTemplateProperties(TClientProperties) or command method.

public override Task ConfigurePage()

Returns

Task

ConfigureTemplateProperties(PersonalDataManagementTemplateClientProperties)

Gets the object representing client side template properties.

public override Task<PersonalDataManagementTemplateClientProperties> ConfigureTemplateProperties(PersonalDataManagementTemplateClientProperties properties)

Parameters

properties PersonalDataManagementTemplateClientProperties

Initialized properties object.

Returns

Task<PersonalDataManagementTemplateClientProperties>

GetInfoCallout()

Configures information callout.

protected abstract CalloutConfiguration GetInfoCallout()

Returns

CalloutConfiguration

Configured callout.

GetWarningCallout()

Configures warning callout.

protected virtual CalloutConfiguration GetWarningCallout()

Returns

CalloutConfiguration

Configured callout.

Search(SearchForPersonalDataParameters)

Endpoint that is responsible for loading data subject personal data based on given parameters.

[PageCommand(Permission = "View")]
public virtual Task<ICommandResponse<SearchForPersonalDataResult>> Search(SearchForPersonalDataParameters args)

Parameters

args SearchForPersonalDataParameters

Returns

Task<ICommandResponse<SearchForPersonalDataResult>>

Data subject personal data in defined OutputFormat.