Kameleoon.API.Triggers - Kameleoon Documentation

This module provides methods to manage triggers and targeting.

getAll

The getAll() method returns all live triggers, including those associated with experiments, personalizations, or Audience tracking.

let triggers = Kameleoon.API.Triggers.getAll();

Return value

Name	Type	Description
triggers	Array	List of Trigger objects.

getById

The getById() method returns the trigger for the specified ID.

let trigger = Kameleoon.API.Triggers.getById(123456);

Arguments

Name	Type	Description
id	Number	ID of the trigger. This field is mandatory.

Return value

Name	Type	Description
trigger	Object	Trigger object.

getByName

The getByName() method returns the trigger for the specified name.

let trigger = Kameleoon.API.Triggers.getByName("My trigger");

Arguments

Name	Type	Description
name	String	Name of the trigger. This field is mandatory.

Return value

Name	Type	Description
trigger	Object	Trigger object.

reevaluate

The reevaluate() method forces an immediate re-evaluation of the targeting conditions for the specified trigger. Evaluation typically occurs at page load, resulting in statuses of true, false, or undefined. This method restarts the evaluation process as if the engine just initialized.

Kameleoon.API.Utils.addEventListener(document.body, "mouseleave", function (event) {
  if (event.clientY < 0) {
    Kameleoon.API.Triggers.reevaluate(123456);
  }
});

Arguments

Name	Type	Description
id	Number	ID of the trigger. This field is mandatory.

trigger

The trigger() method forces a trigger to fire for the current visitor and bypasses targeting conditions.

Kameleoon.API.Triggers.trigger(12345);

Arguments

Name	Type	Description
id	Number	ID of the trigger. This field is mandatory.

APIs

​getAll

​getById

​getByName

​reevaluate

​trigger

getAll

getById

getByName

reevaluate

trigger