Developing personalization condition types

This content cannot be displayed without JavaScript.
Please enable JavaScript and reload the page.

Is this really the version you are looking for? Kentico Xperience 12 Service Pack Documentation is no longer updated. Use the switcher in the header to choose your product version.

Developing personalization condition types | Kentico Xperience 12 Service Pack Documentation

C#Decorating condition type properties

// Assigns the default Kentico text input component to the property
// Allows users to enter a text value for the given property in the configuration dialog
[EditingComponent(TextInputComponent.IDENTIFIER, Order = 0, Label = "Consent code name")]
public string ConsentCodeName { get; set; }

C#Example

using System.ComponentModel.DataAnnotations;

namespace LearningKit.Personalization.ConditionTypes
{
    public class HasGivenConsentViewModel
    {
        [Required]
        [Display(Name = "Consent code name")]
        public string ConsentCodeName { get; set; }
    }
}

C#Example

@model LearningKit.Personalization.ConditionTypes.HasGivenConsentViewModel

@using (Html.BeginForm("Validate", "HasGivenConsent"))
{
    @Html.LabelFor(model => model.ConsentCodeName)
    <br />
    @Html.EditorFor(model => model.ConsentCodeName)
    <br />
    @Html.ValidationMessage("ConsentCodeName")
}

Index() – POST action displaying the configuration form. The action must return the form's HTML content, typically a partial view. To display values of the condition type parameters when editing the form, you need to get the parameters and set them when creating the view model object.

Validate(<model>) – POST action that receives the model of the configuration dialog as its parameter. Validate the model, and if successful, create an instance of the condition type class, serialize it into JSON format using the Json method, and return the data. Upon unsuccessful validation or if any other error occurs, display the configuration dialog partial view with an appropriate error message.

The VariantName property that represents the name of the personalization variant is implemented in the ConditionType base class by default. Make sure this property has a set value before you serialize and return the data.

C#Example

public class HasGivenConsentController : ConditionTypeController<HasGivenConsentConditionType>
{
    // Displays the configuration dialog
    [HttpPost]
    public ActionResult Index()
    {
        // Gets the condition's current configuration as an instance of the condition type class
        var conditionType = GetParameters();

        // Creates a view model object
        var viewModel = new HasGivenConsentViewModel
        {
            // Sets the consent code name obtained from the condition type parameters
            ConsentCodeName = conditionType.ConsentCodeName
        };

        // Displays the configuration dialog's view
        return PartialView("Personalization/ConditionTypes/_HasGivenConsentConfiguration", viewModel);
    }

    // Submits the condition type parameters
    [HttpPost]
    public ActionResult Validate(HasGivenConsentViewModel model)
    {
        // Validates the model
        if (!ModelState.IsValid)
        {
            return PartialView("Personalization/ConditionTypes/_HasGivenConsentConfiguration", model);
        }

        // Creates an object of the condition type class
        var parameters = new HasGivenConsentConditionType
        {
            ConsentCodeName = model.ConsentCodeName,
        };

        // Serializes the condition's configuration into JSON format and returns the data
        return Json(parameters);
    }
}

C#Example - Registering a condition type with a custom dialog

using Kentico.PageBuilder.Web.Mvc.Personalization;

[assembly: RegisterPersonalizationConditionType("LearningKit.Personalization.HasGivenConsentConditionTypeCustom", 
    typeof(HasGivenConsentConditionTypeCustom), "Has given consent agreement (custom)", 
    ControllerType = typeof(HasGivenConsentController), 
    Description = "Evaluates whether the contact has given an agreement with a specified consent declaration.", 
    IconClass = "icon-clipboard-checklist",
    Hint = "Enter the code name of a consent. The condition is fulfilled for visitors who have given an agreement with the given consent.")]

Developing personalization condition types

Creating condition types

Creating condition types with a custom configuration dialog

Implementing custom configuration dialogs

Model

Partial view

Controller

Registering condition types

Cookie consent

Creating condition types

Creating condition types with a custom configuration dialog

Implementing custom configuration dialogs

Model

Partial view

Controller

Registering condition types