#Méthodes

#Access

#noConflict

.noConflict(): this

Si un objet Access est déjà présent dans l'objet global de la page, la librairie Access.js sera renommée PooolAccess et l'objet Access d'origine sera restauré.

#init

.init(appId: String): PaywallFactory

Créé une nouvelle instance d'Access (requis pour afficher des paywalls) à l'aide de votre app ID.

#PaywallFactory

#createPaywall

.createPaywall(options: PaywallOptions): Paywall

Créé une nouvelle instance de Paywall.

#Options

#target
  • Type: String|Element
  • Défaut: '#poool-widget'
Sélecteur CSS ou élément DOM de l'élément qui contiendra le paywall.
#content
  • Type: String|Element
  • Défaut: '[data-poool]'
Sélecteur CSS ou élément DOM de l'élément qui contient le contenu premium dans la page.
#pageType
  • Type: String
  • Défaut: 'page'
Le type de contenu de la page. Le paywall peut être affiché sur des pages de type 'premium' ou 'free'.
#mode
  • Type: String
  • Défaut: 'excerpt'
La méthode utilisée pour bloquer le contenu premium. Voir la documentation de l'option mode pour plus d'informations sur les différents modes.
#percent
  • Type: Number
  • Défaut: 80
Le pourcentage de contenu premium à bloquer. Voir la documentation de l'option percent pour plus d'informations.

#config

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

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

Permet de configurer les options d'Access.js. Voir la documentation des options de configuration.

#texts

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

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

Permet de configurer des textes personnalisés sur le paywall. Voir la documentation concernant les textes personnalisés pour plus d'informations.

#styles

.styles(optionName: String, optionValue: String, readOnly?: Boolean): this

.styles(options: Object, readOnly?: Boolean): this

Permet de configurer les styles personnalisés de l'apparence par défaut. Voir la documentation concernant les styles personnalisés.

#variables

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

.variable(options: Object): this

Permet de configurer des variables personnalisées pour certaines clés textes. Voir la documentation concernant les variables personnalisées.

#on

.on(name: String, callback: Function): this

Permet d'ajouter un listener à un événement particulier. Voir la documentation concernant les évènements.

#once

.once(name: String, callback: Function): this
Même principe que .on(), mais l'événement ne se déclenche qu'une seule fois et le callback est supprimé juste après.

#off

.off(name: String, callback: Function): this
Permet de supprimer un listener d'un événement particulier précédemment ajouté par .on() ou .once().

#destroy

.destroy(): null
Détruit le paywall.