Cordova-Plugin API-Referenz

Beispiel

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

// Sollte vor pushwoosh.onDeviceReady aufgerufen werden
document.addEventListener('push-notification', function(event) {
  var notification = event.notification;
  // hier das Öffnen der Push-Benachrichtigung behandeln
});

// Pushwoosh initialisieren. Dies löst alle ausstehenden Push-Benachrichtigungen beim Start aus.
pushwoosh.onDeviceReady({
  appid: "XXXXX-XXXXX",
  projectid: "XXXXXXXXXXXXXXX",
  serviceName: "XXXX"
});

pushwoosh.registerDevice(
  function(status) {
    var pushToken = status.pushToken;
      // hier die erfolgreiche Registrierung behandeln
  },
  function(status) {
    // hier den Registrierungsfehler behandeln
  }
);

onDeviceReady

PushNotification.prototype.onDeviceReady = function( config )

[android, ios, wp8, windows]
Initialisiert das Pushwoosh-Plugin und löst eine Start-Push-Nachricht aus. Sollte bei jedem App-Start aufgerufen werden.

config.appid – Pushwoosh-Anwendungscode.

config.projectid – GCM-Projektnummer für die Android-Plattform.

config.serviceName – MPNS-Dienstname für die wp8-Plattform.

Beispiel

// Pushwoosh mit projectid: "GOOGLE_PROJECT_NUMBER", appid : "PUSHWOOSH_APP_ID", serviceName : "WINDOWS_PHONE_SERVICE" initialisieren. Dies löst alle ausstehenden Push-Benachrichtigungen beim Start aus.
pushwoosh.onDeviceReady({
    appid : "XXXXX-XXXXX",
    projectid: "XXXXXXXXXXXXXXX",
    serviceName: "XXXX"
});

registerDevice

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

[android, ios, wp8, windows]
Registriert das Gerät für Push-Benachrichtigungen und ruft einen Push-Token ab.

success – Erfolgs-Callback. Der Push-Token wird als „status.pushToken“-Parameter an diesen Callback übergeben.

fail – Fehler-Callback

Beispiel

pushwoosh.registerDevice(
    function(status) {
        alert("Registriert mit Push-Token: " + status.pushToken);
    },
    function(error) {
        alert("Registrierung fehlgeschlagen: " +  error);
    }
);

unregisterDevice

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

[android, ios, wp8, windows]
Hebt die Registrierung des Geräts für den Empfang von Push-Benachrichtigungen auf.

success – Erfolgs-Callback

fail – Fehler-Callback

setTags

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

[android, ios, wp8, windows]
Setzt Tags für das Gerät.

Parameter

config – Objekt mit benutzerdefinierten Geräte-Tags

success – Erfolgs-Callback. Der Push-Token wird als „status.pushToken“-Parameter an diesen Callback übergeben.

fail – Fehler-Callback

Beispiel

// setzt die Tags: „deviceName“ mit dem Wert „hello“ und „deviceId“ mit dem Wert 10
pushwoosh.setTags({deviceName:"hello", deviceId:10},
    function() {
        console.warn('setTags erfolgreich');
    },
    function(error) {
        console.warn('setTags fehlgeschlagen');
    }
);

// setzt Listen-Tags "MyTag" mit den Werten (Array) "hello", "world"
pushwoosh.setTags({"MyTag":["hello", "world"]});

getTags

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

[android, ios, wp8, windows]
Gibt die Tags für das Gerät zurück, einschließlich der Standard-Tags.

success – Erfolgs-Callback. Empfängt Tags als Parameter.

fail – Fehler-Callback

pushwoosh.getTags(
    function(tags) {
        console.warn('Tags für das Gerät: ' + JSON.stringify(tags));
    },
    function(error) {
        console.warn('Fehler beim Abrufen der Tags: ' + JSON.stringify(error));
    }
);

getPushToken

PushNotification.prototype.getPushToken = function(  success  )

[android, ios, wp8, windows]
Gibt den Push-Token zurück, falls er verfügbar ist. Beachten Sie, dass der Token auch im Callback der registerDevice-Funktion zurückgegeben wird.

success – Erfolgs-Callback.

pushwoosh.getPushToken(
    function(token) {
        console.warn('Push-Token: ' + token);
    }
);

getPushwooshHWID

PushNotification.prototype.getPushwooshHWID = function(  success  )

[android, ios, wp8, windows]
Gibt die Pushwoosh-HWID zurück, die für die Kommunikation mit der Pushwoosh-API verwendet wird.

success – getPushwooshHWID-Callback

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

getRemoteNotificationStatus

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

[android, ios]
Gibt den detaillierten Status der Berechtigungen für Push-Benachrichtigungen zurück.

callback – Erfolgs-Callback. Empfängt ein Objekt mit den folgenden Eigenschaften:

{
  "enabled" : Flag für aktivierte Benachrichtigungen.
  "pushBadge" : Berechtigung für Badges erteilt. (nur iOS)
  "pushAlert" : Berechtigung für Alarme erteilt. (nur iOS)
  "pushSound" : Berechtigung für Töne erteilt. (nur iOS)
}

error — Fehler-Callback

setApplicationIconBadgeNumber

PushNotification.prototype.setApplicationIconBadgeNumber = function(  badgeNumber  )

[android, ios]
Setzt die Badge-Nummer des Anwendungssymbols.

badgeNumber – Badge-Nummer des Symbols

getApplicationIconBadgeNumber

PushNotification.prototype.getApplicationIconBadgeNumber = function(  callback  )

[android, ios]
Gibt die Badge-Nummer des Anwendungssymbols zurück.

callback – Erfolgs-Callback

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

addToApplicationIconBadgeNumber

PushNotification.prototype.addToApplicationIconBadgeNumber = function( badgeNumber )

[android, ios]
Fügt einen Wert zur Badge des Anwendungssymbols hinzu.

badgeNumber — inkrementelle Badge-Nummer des Symbols

getLaunchNotification

PushNotification.prototype.getLaunchNotification = function(  callback  )

[android, ios]
Gibt die Nutzdaten der Push-Benachrichtigung zurück, wenn die App als Reaktion auf eine Push-Benachrichtigung gestartet wurde, andernfalls null.

callback – Erfolgs-Callback

clearLaunchNotification

PushNotification.prototype.clearLaunchNotification = function(  callback  )

[android, ios]
Löscht die Startbenachrichtigung. getLaunchNotification() gibt nach diesem Aufruf null zurück.

setUserId

PushNotification.prototype.setUserId = function(  userId  )

[android, ios]
Setzt die Benutzerkennung – eine Facebook-ID, einen Benutzernamen, eine E-Mail oder eine andere Benutzer-ID. Dies ermöglicht es, Daten und Ereignisse über mehrere Geräte eines Benutzers hinweg abzugleichen.

userId – Benutzer-String-Kennung

postEvent

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

[android, ios]
Postet Ereignisse für In-App-Nachrichten. Dies kann die Anzeige von In-App-Nachrichten auslösen, wie im Pushwoosh Control Panel festgelegt.

event – auszulösendes Ereignis

attributes – Objekt mit zusätzlichen Ereignisattributen

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

createLocalNotification

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

[android, ios]
Plant eine lokale Benachrichtigung.

config.msg – Benachrichtigungstext

config.seconds – Benachrichtigungsverzögerung in Sekunden

config.userData – zusätzliche Daten, die in der Benachrichtigung übergeben werden

success – Erfolgs-Callback

fail – Fehler-Callback

pushwoosh.createLocalNotification({msg:"Ihre Kürbisse sind fertig!", seconds:30, userData:{}})

clearLocalNotification

PushNotification.prototype.clearLocalNotification = function()

[android]
Löscht alle ausstehenden lokalen Benachrichtigungen, die von createLocalNotification erstellt wurden.

clearNotificationCenter

PushNotification.prototype.clearNotificationCenter = function()

[android]
Löscht alle im Android Notification Center angezeigten Benachrichtigungen.

setMultiNotificationMode

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

[android]
Ermöglicht die Anzeige mehrerer Benachrichtigungen im Android Notification Center.

setSingleNotificationMode

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

[android]
Ermöglicht, dass nur die letzte Benachrichtigung im Android Notification Center angezeigt wird.

setSoundType

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

[android]
Setzt den Standardton für eingehende Pushes.

type – Tontyp (0 – Standard, 1 – kein Ton, 2 – immer)

setVibrateType

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

[android]
Setzt den Standard-Vibrationsmodus für eingehende Pushes.

type – Vibrationstyp (0 – Standard, 1 – keine Vibration, 2 – immer)

setLightScreenOnNotification

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

[android]
Schaltet den Bildschirm ein, wenn eine Benachrichtigung eintrifft.

on – Bildschirm-Entsperrung aktivieren/deaktivieren (standardmäßig deaktiviert)

setEnableLED

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

[android]
Aktiviert das Blinken der LED, wenn eine Benachrichtigung eintrifft und das Display ausgeschaltet ist.

on – LED-Blinken aktivieren/deaktivieren (standardmäßig deaktiviert)

setColorLED

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

[android]
Setzt die LED-Farbe. Verwenden Sie dies mit setEnableLED.

color – LED-Farbe im ARGB-Integer-Format

getPushHistory

PushNotification.prototype.getPushHistory = function(  success  )

[android]
Gibt ein Array der empfangenen Push-Benachrichtigungen zurück.

success – Erfolgs-Callback

pushwoosh.getPushHistory(function(pushHistory) {
    if(pushHistory.length == 0)
        alert("keine Push-Historie");
    else
        alert(JSON.stringify(pushHistory));
});

pushwoosh.clearPushHistory();

clearPushHistory

PushNotification.prototype.clearPushHistory = function()

[android]
Löscht die Push-Historie.

cancelAllLocalNotifications

PushNotification.prototype.cancelAllLocalNotifications = function( callback )

[ios]
Löscht alle lokalen Benachrichtigungen aus dem Notification Center.

presentInboxUI

[android, ios]
Öffnet den Inbox-Bildschirm.

PushNotification.prototype.presentInboxUI = function()

setCommunicationEnabled

Eine binäre Methode, die die gesamte Kommunikation mit Pushwoosh aktiviert/deaktiviert. Der boolesche Wert false meldet das Gerät vom Empfang von Push-Benachrichtigungen ab und stoppt den Download von In-App-Nachrichten. Der Wert true kehrt den Effekt um.

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

removeAllDeviceData

Entfernt alle Daten über das Gerät.

PushNotification.prototype.removeAllDeviceData = function()

push-receive

[android, ios]
Ereignis für den Empfang von Push-Benachrichtigungen. Wird ausgelöst, wenn die Anwendung eine Push-Benachrichtigung im Vorder- oder Hintergrund empfängt. Geschlossene Anwendungen empfangen dieses Ereignis nicht.

Ereigniseigenschaften

message – (string) Nachricht der Push-Benachrichtigung

userdata – (object/array) Benutzerdefinierte Daten der Push-Benachrichtigung

onStart – (boolean) Ist eine Startbenachrichtigung

foreground – (boolean) Wird die Benachrichtigung im Vordergrund empfangen

android – (object) Android-spezifische Nutzdaten der Benachrichtigung

ios – (object) iOS-spezifische Nutzdaten der Benachrichtigung

windows – (object) Windows-spezifische Nutzdaten der Benachrichtigung

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

    if (typeof(userData) != "undefined") {
      // benutzerdefinierte Benachrichtigungsdaten behandeln
      console.warn('Benutzerdaten: ' + JSON.stringify(userData));
    }
  }
);

Vordergrund-Benachrichtigungen

Standardmäßig zeigt das Pushwoosh-Plugin keine Benachrichtigungen im Vordergrund an und löst automatisch das push-receive-Ereignis aus. Siehe die Anleitung zur Plugin-Anpassung, um dieses Verhalten zu steuern.

push-notification

[android, ios, wp8, windows]
Ereignis zur Annahme einer Push-Benachrichtigung. Es wird ausgelöst, wenn der Benutzer auf die Push-Benachrichtigung tippt.

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

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

Ereigniseigenschaften

Gleich wie bei push-receive

additionalAuthorizationOptions

[nur ios]
Bietet zusätzliche Autorisierungsoptionen für Benachrichtigungen. Sollte vor dem Aufruf von registerDevice aufgerufen werden.

pushwoosh.additionalAuthorizationOptions({
  "UNAuthorizationOptionCriticalAlert" : 1,
  "UNAuthorizationOptionProvisional": 0 // setzen Sie 0 oder lassen Sie die Option weg, wenn Sie sie nicht zu Ihrer App hinzufügen möchten.
});