Passer au contenu
Guides utilisateur Guides pratiques Support Demander une démo Se connecter
Pushwoosh.com

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

exemple
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",
  serviceName: "XXXX"
});


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

onDeviceReady

Anchor link to
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.serviceName – Nom du service MPNS pour la plateforme wp8.

exemple
// initialize Pushwoosh with appid : "PUSHWOOSH_APP_ID", serviceName : "WINDOWS_PHONE_SERVICE". This will trigger all pending push notifications on start.
pushwoosh.onDeviceReady({
    appid : "XXXXX-XXXXX",
    serviceName: "XXXX"
});

registerDevice

Anchor link to
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.

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

unregisterDevice

Anchor link to
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

Anchor link to
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.

exemple
// sets tags: “deviceName” with value “hello” and “deviceId” with value 10
pushwoosh.setTags({deviceName:"hello", deviceId:10},
    function() {
        console.warn('setTags success');
    },
    function(error) {
        console.warn('setTags failed');
    }
);


// sets list tags "MyTag" with values (array) "hello", "world"
pushwoosh.setTags({"MyTag":["hello", "world"]});

getTags

Anchor link to
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 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

Anchor link to
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

Anchor link to
PushNotification.prototype.getPushwooshHWID = function(  success  )

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

success – callback de getPushwooshHWID.

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

getRemoteNotificationStatus

Anchor link to
PushNotification.prototype.getRemoteNotificationStatus = function(  callback, error  )

[android, ios]
Retourne le statut détaillé des autorisations de notification push.

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

{
  "enabled" : drapeau 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

Anchor link to
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

Anchor link to
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

Anchor link to
PushNotification.prototype.addToApplicationIconBadgeNumber = function( badgeNumber )

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

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

getLaunchNotification

Anchor link to
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

Anchor link to
PushNotification.prototype.clearLaunchNotification = function(  callback  )

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

setUserId

Anchor link to
PushNotification.prototype.setUserId = function(  userId  )

[android, ios]
Définit l’identifiant utilisateur (User ID) – un ID Facebook, un nom d’utilisateur, une adresse 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 de l’utilisateur (chaîne de caractères).

postEvent

Anchor link to
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

Anchor link to
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

Anchor link to
PushNotification.prototype.clearLocalNotification = function()

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

clearNotificationCenter

Anchor link to
PushNotification.prototype.clearNotificationCenter = function()

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

setMultiNotificationMode

Anchor link to
PushNotification.prototype.setMultiNotificationMode = function( success, fail )

[android]
Permet à plusieurs notifications d’être affichées dans le centre de notifications d’Android.

setSingleNotificationMode

Anchor link to
PushNotification.prototype.setSingleNotificationMode = function(  success,
fail  )

[android]
Permet uniquement à la dernière notification d’être affichée dans le centre de notifications d’Android.

setSoundType

Anchor link to
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

Anchor link to
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

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

[android]
Allume l’écran lorsqu’une notification arrive.

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

setEnableLED

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

[android]
Active le clignotement de la LED lorsqu’une notification arrive et que l’écran est éteint.

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

setColorLED

Anchor link to
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

Anchor link to
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

Anchor link to
PushNotification.prototype.clearPushHistory = function()

[android]
Efface l’historique des notifications push.

cancelAllLocalNotifications

Anchor link to
PushNotification.prototype.cancelAllLocalNotifications = function( callback )

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

presentInboxUI

Anchor link to

[android, ios]
Ouvre l’écran de la Boîte de réception. Accepte un objet de style optionnel. Consultez Configurer la boîte de réception des messages pour Cordova pour la liste complète des clés de style.

PushNotification.prototype.presentInboxUI = function( params )

loadMessages

Anchor link to

[android, ios]
Charge le tableau des messages de la boîte de réception.

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

unreadMessagesCount

Anchor link to

[android, ios]
Retourne le nombre de messages non lus dans la boîte de réception.

PushNotification.prototype.unreadMessagesCount = function( success )

messagesCount

Anchor link to

[android, ios]
Retourne le nombre total de messages dans la boîte de réception.

PushNotification.prototype.messagesCount = function( success )

messagesWithNoActionPerformedCount

Anchor link to

[android, ios]
Retourne le nombre de messages de la boîte de réception pour lesquels aucune action n’a été effectuée.

PushNotification.prototype.messagesWithNoActionPerformedCount = function( success )

readMessage

Anchor link to

[android, ios]
Marque un message de la boîte de réception comme lu.

PushNotification.prototype.readMessage = function( number )

deleteMessage

Anchor link to

[android, ios]
Supprime un message de la boîte de réception.

PushNotification.prototype.deleteMessage = function( number )

performAction

Anchor link to

[android, ios]
Exécute l’action assignée à un message de la boîte de réception, par ex. l’ouverture d’une URL.

PushNotification.prototype.performAction = function( number )

setCommunicationEnabled

Anchor link to

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

Anchor link to

Supprime toutes les données concernant l’appareil.

PushNotification.prototype.removeAllDeviceData = function()

push-receive

Anchor link to

[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-ce 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") {
      // handle custom notification data
      console.warn('user data: ' + JSON.stringify(userData));
    }
  }
);

Notifications en premier plan

Anchor link to

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

Anchor link to

[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

Anchor link to

[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 // set 0 or don't specify the option if you don't want to add it to your app.
});