Reference

Method	Description
help	Displays a list of available commands in the console
activate / logout	Activates the tag with an identity or removes an identity, effectively stopping the tag. Needed when authentication is enabled.
get	Getters for retrieving public properties
set	Getters for defining public properties
on / off	Event listeners to watch for changes of specific properties
recordTransaction	Inform iAdvize that a transaction has occurred on your website
navigate	Changes the current screen and restart the tag, allowing a new targeting run

iAdvize.help

• Lists all the available methods,

• Lists all the available properties on get and set,

• Lists all the available events on on and off.

iAdvize.activate / iAdvize.logout

These methods are used for authentication. Please see the dedicated Help Center article : https://help.iadvize.com/hc/articles/6043078724626

iAdvize.get

iAdvize.get takes a single property argument, and returns the associated value. Properties are keys that reference values that can change over time. These values can be accessed :

• directly, using iAdvize.get (ex: iAdvize.get('visitor:cookiesConsent'))

• when they change, using iAdvize.on (ex: iAdvize.on('visitor:cookiesConsentChange', callback))

Property	Description	Values
chatbox:status	The status of the chatbox	OPENED, REDUCED, CLOSED (default)
conversation:id	The id of the conversation	string, null (default)
tag:version	The tag version	"LIGHT", "FULL"
visitor:cookiesConsent	Whether the visitor consented to cookies or not	true, false, null (default)
visitor:GDPRConsent	Whether the visitor consented to GDPR or not	true, false, null (default)
visitor:sourceId	The ID of the visitor	string, null (default)
engagementRules:triggered	Get all the triggered rules id on the page	string[] Array of ids of engagement rules
engagementNotifications:displayed	Get all the notifications displayed on the page	object[] type: "BADGE", "CLASSIC", "MESSAGING", "INVITATION", "MINI_BADGE", "CHATBOX", "MESSAGE", "CUSTOM_BUTTON", "EMBEDDED_CONVERSATION_STARTER" id: string ruleId: string channels: ["CHAT", "CALL", "VIDEO", "MESSENGER", "SMS", "WHATSAPP"]

Example :

window.iAdvizeInterface = window.iAdvizeInterface || [];
window.iAdvizeInterface.push(function (iAdvize) {
  const visitorCookiesConsent = iAdvize.get('visitor:cookiesConsent');
});

iAdvize.set

Set editable properties.

Property	Description	Values
visitor:cookiesConsent	Whether the visitor consented to cookies or not	true, false
visitor:GDPRConsent	Whether the visitor consented to GDPR or not	true, false

Example :

window.iAdvizeInterface = window.iAdvizeInterface || [];
window.iAdvizeInterface.push(function (iAdvize) {
  iAdvize.set('visitor:GDPRConsent', true);
});

iAdvize.on / iAdvize.off

Listen to a property change.

iAdvize.on takes two arguments :

• The name of an event,

• A callback that takes the associated event value and the previous value as parameter.

Every property available on iAdvize.get also has a corresponding event (iAdvize.on('{property}Change', (value, previousValue) => {...})).

iAdvize.off takes the same arguments to remove the event listener.

Example :

window.iAdvizeInterface = window.iAdvizeInterface || [];
window.iAdvizeInterface.push(function (iAdvize) {
  iAdvize.on('visitor:cookiesConsentChange', function (visitorCookiesConsent, previousValue) {
    // The new value 
    console.log(visitorCookiesConsent);
    // The previous Value
    console.log(previousValue);
  });
});

Listenable events

Some specific events can be listened with the on method :

Event name	Description	Values
engagementRule:triggered	Called when an engagement rule is triggered on the page	string Id of engagement rule
engagementNotification:displayed	Triggered when a notification is displayed on the page	object type: "BADGE", "CLASSIC", "MESSAGING", "INVITATION", "MINI_BADGE", "CHATBOX", "MESSAGE", "CUSTOM_BUTTON", "EMBEDDED_CONVERSATION_STARTER" id: string ruleId: string channels: ["CHAT", "CALL", "VIDEO", "MESSENGER", "SMS", "WHATSAPP"]
engagementNotification:clicked	Triggered when the notification is clicked	object type: "BADGE", "CLASSIC", "MESSAGING", "INVITATION", "MINI_BADGE", "CUSTOM_BUTTON", "EMBEDDED_CONVERSATION_STARTER" id: string ruleId: string channel: "CHAT", "CALL", "VIDEO", "MESSENGER", "SMS", "WHATSAPP" text: string (is only filled for the starters, otherwise null)

iAdvize.recordTransaction

Allows to record transactions. See the dedicated article on the Help Center: https://help.iadvize.com/hc/en-gb/articles/206375538

Example :

window.iAdvizeInterface = window.iAdvizeInterface || [];
window.iAdvizeInterface.push(function (iAdvize) {
  iAdvize.recordTransaction({
    id: 'unique-id',
    amount: 49.95,
  });
});

iAdvize.navigate

Argument	Type	Description
path	String	Path/URL you wish to tell iAdvize where the visitor is "virtually" browsing

If part of your web site is built using SPA technology that does not update your browser's history (=your site's url does not change, even though the page displayed to the visitor does), you can simulate a page change using the iAdvize.navigate("YOUR_PATH") method.

This will restart iAdvize's targeting engine to take into account the new URL/path value you enter as parameter.