Référence de l'API du plugin Cordova

example

var pushwoosh = cordova.require("pushwoosh-cordova-plugin.PushNotification");

// Should be called before pushwoosh.onDeviceReady
document.addEventListener('push-notification', function(event) {
  var notification = event.notification;
  // handle push open here
});

// Initialize Pushwoosh. This will trigger all pending push notifications on start.
pushwoosh.onDeviceReady({
  appid: "XXXXX-XXXXX",
  projectid: "XXXXXXXXXXXXXXX",
  serviceName: "XXXX"
});

pushwoosh.registerDevice(
  function(status) {
    var pushToken = status.pushToken;
      // handle successful registration here
  },
  function(status) {
    // handle registration error here
  }
);

onDeviceReady

PushNotification.prototype.onDeviceReady = function( config )

[android, ios, wp8, windows]
Initialise le plugin Pushwoosh et déclenche un message push de démarrage. Doit être appelée à chaque lancement de l’application.

config.appid – Code d’application Pushwoosh.

config.projectid – Numéro de projet GCM pour la plateforme Android.

config.serviceName – Nom du service MPNS pour la plateforme wp8.

example

// initialise Pushwoosh avec projectid : "GOOGLE_PROJECT_NUMBER", appid : "PUSHWOOSH_APP_ID", serviceName : "WINDOWS_PHONE_SERVICE". Cela déclenchera toutes les notifications push en attente au démarrage.
pushwoosh.onDeviceReady({
    appid : "XXXXX-XXXXX",
    projectid: "XXXXXXXXXXXXXXX",
    serviceName: "XXXX"
});

registerDevice

PushNotification.prototype.registerDevice = function( success, fail )

[android, ios, wp8, windows]
Enregistre l’appareil pour les notifications push et récupère un jeton push (Push Token).

success – callback de succès. Le jeton push est passé en tant que paramètre “status.pushToken” à ce callback.

fail – callback d’erreur.

example

pushwoosh.registerDevice(
    function(status) {
        alert("Registered with push token: " + status.pushToken);
    },
    function(error) {
        alert("Failed to register: " +  error);
    }
);

unregisterDevice

PushNotification.prototype.unregisterDevice = function(  success, fail  )

[android, ios, wp8, windows]
Désenregistre l’appareil de la réception des notifications push.

success – callback de succès.

fail – callback d’erreur.

setTags

PushNotification.prototype.setTags = function(  config, success, fail  )

[android, ios, wp8, windows]
Définit les tags pour l’appareil.

Paramètres

config – objet avec les tags personnalisés de l’appareil.

success – callback de succès. Le jeton push est passé en tant que paramètre “status.pushToken” à ce callback.

fail – callback d’erreur.

example

// définit les tags : “deviceName” avec la valeur “hello” et “deviceId” avec la valeur 10
pushwoosh.setTags({deviceName:"hello", deviceId:10},
    function() {
        console.warn('setTags success');
    },
    function(error) {
        console.warn('setTags failed');
    }
);

// définit les tags de liste "MyTag" avec les valeurs (tableau) "hello", "world"
pushwoosh.setTags({"MyTag":["hello", "world"]});

getTags

PushNotification.prototype.getTags = function(  success, fail  )

[android, ios, wp8, windows]
Retourne les tags pour l’appareil, y compris les tags par défaut.

success – callback de succès. Reçoit les tags en tant que paramètres.

fail – callback d’erreur.

pushwoosh.getTags(
    function(tags) {
        console.warn('tags for the device: ' + JSON.stringify(tags));
    },
    function(error) {
        console.warn('get tags error: ' + JSON.stringify(error));
    }
);

getPushToken

PushNotification.prototype.getPushToken = function(  success  )

[android, ios, wp8, windows]
Retourne le jeton push s’il est disponible. Notez que le jeton est également fourni dans le callback de la fonction registerDevice.

success – callback de succès.

pushwoosh.getPushToken(
    function(token) {
        console.warn('push token: ' + token);
    }
);

getPushwooshHWID

PushNotification.prototype.getPushwooshHWID = function(  success  )

[android, ios, wp8, windows]
Retourne le HWID Pushwoosh utilisé pour les communications avec l’API Pushwoosh.

success – callback de getPushwooshHWID.

pushwoosh.getPushwooshHWID(
    function(token) {
        console.warn('Pushwoosh HWID: ' + token);
    }
);

getRemoteNotificationStatus

PushNotification.prototype.getRemoteNotificationStatus = function(  callback, error  )

[android, ios]
Retourne l’état détaillé des autorisations de notification push.

callback – callback de succès. Reçoit un objet avec les propriétés suivantes :

{
  "enabled" : indicateur d'activation des notifications.
  "pushBadge" : autorisation pour les pastilles accordée. (iOS uniquement)
  "pushAlert" : autorisation pour les alertes accordée. (iOS uniquement)
  "pushSound" : autorisation pour les sons accordée. (iOS uniquement)
}

error — callback d’erreur.

setApplicationIconBadgeNumber

PushNotification.prototype.setApplicationIconBadgeNumber = function(  badgeNumber  )

[android, ios]
Définit le numéro de la pastille sur l’icône de l’application.

badgeNumber – numéro de la pastille sur l’icône.

getApplicationIconBadgeNumber

PushNotification.prototype.getApplicationIconBadgeNumber = function(  callback  )

[android, ios]
Retourne le numéro de la pastille sur l’icône de l’application.

callback – callback de succès.

pushwoosh.getApplicationIconBadgeNumber(function(badge){ alert(badge);} );

addToApplicationIconBadgeNumber

PushNotification.prototype.addToApplicationIconBadgeNumber = function( badgeNumber )

[android, ios]
Ajoute une valeur à la pastille de l’icône de l’application.

badgeNumber — numéro incrémental pour la pastille de l’icône.

getLaunchNotification

PushNotification.prototype.getLaunchNotification = function(  callback  )

[android, ios]
Retourne la charge utile de la notification push si l’application a été démarrée en réponse à une notification push, ou null.

callback – callback de succès.

clearLaunchNotification

PushNotification.prototype.clearLaunchNotification = function(  callback  )

[android, ios]
Efface la notification de lancement, getLaunchNotification() retournera null après cet appel.

setUserId

PushNotification.prototype.setUserId = function(  userId  )

[android, ios]
Définit l’identifiant utilisateur (User ID) – un ID Facebook, un nom d’utilisateur, un e-mail ou tout autre ID utilisateur. Cela permet de faire correspondre les données et les événements sur plusieurs appareils de l’utilisateur.

userId – identifiant utilisateur de type chaîne de caractères.

postEvent

PushNotification.prototype.postEvent = function( event, attributes )

[android, ios]
Publie des événements pour les messages In-App. Cela peut déclencher l’affichage d’un message In-App comme spécifié dans le panneau de contrôle Pushwoosh.

event – événement à déclencher.

attributes – objet avec des attributs d’événement supplémentaires.

pushwoosh.setUserId("XXXXXX");
pushwoosh.postEvent("buttonPressed", { "buttonNumber" : 4, "buttonLabel" : "banner" });

createLocalNotification

PushNotification.prototype.createLocalNotification = function( config, success, fail )

[android, ios]
Planifie une notification locale.

config.msg – message de la notification.

config.seconds – délai de la notification en secondes.

config.userData – données supplémentaires à passer dans la notification.

success – callback de succès.

fail – callback d’erreur.

pushwoosh.createLocalNotification({msg:"Your pumpkins are ready!", seconds:30, userData:{}})

clearLocalNotification

PushNotification.prototype.clearLocalNotification = function()

[android]
Efface toutes les notifications locales en attente créées par createLocalNotification.

clearNotificationCenter

PushNotification.prototype.clearNotificationCenter = function()

[android]
Efface toutes les notifications présentées dans le centre de notifications Android.

setMultiNotificationMode

PushNotification.prototype.setMultiNotificationMode = function( success, fail )

[android]
Permet d’afficher plusieurs notifications dans le centre de notifications Android.

setSingleNotificationMode

PushNotification.prototype.setSingleNotificationMode = function(  success,
fail  )

[android]
Permet d’afficher uniquement la dernière notification dans le centre de notifications Android.

setSoundType

PushNotification.prototype.setSoundType = function( type, success, fail )

[android]
Définit le son par défaut pour les notifications push entrantes.

type – Type de son (0 – par défaut, 1 – pas de son, 2 – toujours).

setVibrateType

PushNotification.prototype.setVibrateType = function(type, success, fail )

[android]
Définit le mode de vibration par défaut pour les notifications push entrantes.

type – Type de vibration (0 – par défaut, 1 – pas de vibration, 2 – toujours).

setLightScreenOnNotification

PushNotification.prototype.setLightScreenOnNotification = function( on, success, fail )

[android]
Allume l’écran à l’arrivée d’une notification.

on – activer/désactiver le déverrouillage de l’écran (désactivé par défaut).

setEnableLED

PushNotification.prototype.setEnableLED = function( on, success, fail )

[android]
Active le clignotement de la LED à l’arrivée d’une notification lorsque l’écran est éteint.

on – activer/désactiver le clignotement de la LED (désactivé par défaut).

setColorLED

PushNotification.prototype.setColorLED = function( color, success, fail )

[android]
Définit la couleur de la LED. À utiliser avec setEnableLED.

color – Couleur de la LED au format entier ARGB.

getPushHistory

PushNotification.prototype.getPushHistory = function(  success  )

[android]
Retourne un tableau des notifications push reçues.

success – callback de succès.

pushwoosh.getPushHistory(function(pushHistory) {
    if(pushHistory.length == 0)
        alert("no push history");
    else
        alert(JSON.stringify(pushHistory));
});

pushwoosh.clearPushHistory();

clearPushHistory

PushNotification.prototype.clearPushHistory = function()

[android]
Efface l’historique des notifications push.

cancelAllLocalNotifications

PushNotification.prototype.cancelAllLocalNotifications = function( callback )

[ios]
Efface toutes les notifications locales du centre de notifications.

presentInboxUI

[android, ios]
Ouvre l’écran Boîte de réception.

PushNotification.prototype.presentInboxUI = function()

setCommunicationEnabled

Une méthode binaire activant/désactivant toute communication avec Pushwoosh. La valeur booléenne false désabonne l’appareil de la réception des notifications push et arrête le téléchargement des messages in-app. La valeur true inverse l’effet.

PushNotification.prototype.setCommunicationEnabled = function(enable, success, fail)

removeAllDeviceData

Supprime toutes les données relatives à l’appareil.

PushNotification.prototype.removeAllDeviceData = function()

push-receive

[android, ios]
Événement de réception de notification push. Est déclenché lorsque l’application reçoit une notification push en premier plan ou en arrière-plan. Les applications fermées ne reçoivent pas cet événement.

Propriétés de l’événement

message – (string) Message de la notification push

userdata – (object/array) Données personnalisées de la notification push

onStart – (boolean) Est une notification de lancement

foreground – (boolean) La notification est-elle reçue en premier plan

android – (object) Charge utile de notification spécifique à Android

ios – (object) Charge utile de notification spécifique à iOS

windows – (object) Charge utile de notification spécifique à Windows

document.addEventListener('push-receive',
  function(event) {
    var userData = event.notification.userdata;

    if (typeof(userData) != "undefined") {
      // gérer les données de notification personnalisées
      console.warn('user data: ' + JSON.stringify(userData));
    }
  }
);

Notifications en premier plan

Par défaut, le plugin Pushwoosh n’affiche pas les notifications en premier plan et déclenche automatiquement l’événement push-receive. Consultez le guide de personnalisation du plugin pour contrôler ce comportement.

push-notification

[android, ios, wp8, windows]
Événement d’acceptation de la notification push. Il est déclenché lorsque l’utilisateur appuie sur la notification push.

document.addEventListener('push-notification',
  function(event) {
    var message = event.notification.message;
    var userData = event.notification.userdata;

    if (typeof(userData) != "undefined") {
      console.warn('user data: ' + JSON.stringify(userData));
    }
  }
);

Propriétés de l’événement

Identiques à push-receive

additionalAuthorizationOptions

[ios only]
Fournit des options d’autorisation de notification supplémentaires. Doit être appelée avant d’appeler registerDevice.

pushwoosh.additionalAuthorizationOptions({
  "UNAuthorizationOptionCriticalAlert" : 1,
  "UNAuthorizationOptionProvisional": 0 // définissez 0 ou ne spécifiez pas l'option si vous ne voulez pas l'ajouter à votre application.
});