#Méthodes

#Méthodes globales

#noConflict

.noConflict(): Engage

Si un élément Engage existe déjà dans l'objet global de la page actuelle, la bibliothèque Engage.js sera renommée en PooolEngage et l'objet Engage original sera restauré.

#init

.init(appId: String): Engage

Crée une nouvelle instance Engage (nécessaire pour afficher les éléments) en utilisant votre ID d'application.

#createElement

.createElement(slug: String, target: String | Node): Promise<EngageElement>

Crée une nouvelle instance d'élement manuellement

#autoCreate

.autoCreate(opts?: { filters?: Array<String> }): Promise<Array<EngageElement>>

Crée tous les éléments correspondant à plusieurs conditions telles que le device, le pays, les filtres personnalisés, etc.

#commitPageView

.commitPageView(): Engage

Incrémente le compteur de pages vues dans le localStorage du navigateur pour les éléments avec une limite de pages vues.

Vous pouvez également utiliser cette méthode pour baser le capping sur les sessions au lieu des pages vues :

#config

.config(optionName: String, optionValue: Any, readOnly?: Boolean): Engage

.config(options: Object, readOnly?: Boolean): Engage

Permet de définir certaines options de configuration. Voir la documentation des options de configuration.

#texts

.texts(keyName: String, text: String, readOnly?: Boolean, locale?: String): Engage

.texts(options: Object, readOnly?: Boolean, locale?: String): Engage

Permet de surcharger certains textes définis en dur. Voir la documentation des textes.

#variables

.variable(name: String, value: Any): Engage

.variable(options: Object): Engage

Permet de définir des variables personnalisées à remplacer dans certaines clés de texte. Voir la documentation des variables.

#on

.on(name: String, callback: Function, opts?: { once?: Boolean }): Engage

Permet de définir un callback à appeler lorsqu'un événement spécifique est déclenché. Voir la documentation des événements.

#off

.off(name: String, callback: Function): Engage

Permet de supprimer un callback d'événement précédemment défini avec .on().

#Méthodes sur un élément

#destroy

.destroy(): Promise

Détruit l'élément.

PrécédentInstaller Engage.js

SuivantConfigurer Engage.js