#Méthodes

#Subscribe

#noConflict

.noConflict(): this

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

#init

.init(appId: String): ElementsFactory

Créé une nouvelle instance de Subscribe (requis pour afficher n'importe quel élément) en utilisant votre identifiant d'application.

#ElementsFactory

#createAuthElement

.createAuthElement(name: String, options: Object): Promise<AuthElement>

Crée une nouvel Auth Element.

#name

Type: string
Valeurs acceptées: 'signin-button', 'signin-with-subscribe-button'

Nom de l'élement à afficher.

Éléments disponibles :

signin-button: Permet d'afficher un bouton de connexion redirigeant vers votre plateforme Subscribe
signin-with-subscribe-button: Affiche le même bouton de connexion que signin-button, mais ajoute également un bouton S'abonner à partir de X qui affiche le prix de n'importe quelle offre sélectionnée

#Options

#target

Type: String|Element
Défaut: 'body'

Sélecteur CSS ou élément DOM de l'élément parent qui contiendra l'élément Subscribe.

#offer

Type: String
Défaut: null

Slug représentant l'offre que vous souhaitez mettre en avant dans l'element signin-with-subscribe-button (affichera S'abonner à partir de *le prix de l'offre mise en avant*)

#styles

Type: Object
Défaut: null

Permet d'ajouter des styles personnalisés à vos elements Subscribe.

#config

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

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

Permet de configurer les options de Subscribe.js. Voir la documentation des options de configuration.

#getUser

.getUser(): Promise<UserModel>

Permet de récupérer les informations de l'utilisateur actuellement connecté. Retourne undefined si aucun utilisateur n'est connecté.

Cette méthode retourne un UserModel représenté sous cette forme :

#signout

.signout(): Promise<this>

Permet de déconnecter l'utilisateur courant.

#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().

#AuthElement

#destroy

.destroy(): Promise<null>

Détruit l'élément.

PrécédentInstallation

SuivantConfigurer Subscribe.js