Cordova-Plugin API-Referenz

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",
  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]
Initialisiert das Pushwoosh-Plugin und löst eine Start-Push-Nachricht aus. Sollte bei jedem App-Start aufgerufen werden.

config.appid – Pushwoosh-Anwendungscode.

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

example

// 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

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

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]
Deregistriert das Gerät vom Empfang von Push-Benachrichtigungen.

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

example

// 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

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

[android, ios, wp8, windows]
Gibt 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 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]
Gibt den Push-Token zurück, falls er verfügbar ist. Beachten Sie, dass der Token auch im Callback der registerDevice-Funktion übergeben 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 Ton 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 Payload 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 den Benutzeridentifikator – eine Facebook-ID, einen Benutzernamen, eine E-Mail-Adresse oder eine andere Benutzer-ID. Dies ermöglicht den Abgleich von Daten und Events über mehrere Geräte eines Benutzers hinweg.

userId – Benutzer-String-Identifikator

postEvent

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

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

event – auszulösendes Event

attributes – Objekt mit zusätzlichen Event-Attributen

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 – Benachrichtigungsnachricht

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:"Your pumpkins are ready!", 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 Benachrichtigungen, die im Android Notification Center angezeigt werden.

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. In Verbindung mit setEnableLED verwenden.

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("no push history");
    else
        alert(JSON.stringify(pushHistory));
});

pushwoosh.clearPushHistory();

clearPushHistory

PushNotification.prototype.clearPushHistory = function()

[android]
Löscht den Push-Verlauf.

cancelAllLocalNotifications

PushNotification.prototype.cancelAllLocalNotifications = function( callback )

[ios]
Löscht alle lokalen Benachrichtigungen aus der Benachrichtigungszentrale.

presentInboxUI

[android, ios]
Öffnet den Inbox-Bildschirm. Akzeptiert ein optionales Stilobjekt. Die vollständige Liste der Stilschlüssel finden Sie unter Einrichten der Message Inbox für Cordova.

PushNotification.prototype.presentInboxUI = function( params )

loadMessages

[android, ios]
Lädt das Array der Inbox-Nachrichten.

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

unreadMessagesCount

[android, ios]
Gibt die Anzahl der ungelesenen Inbox-Nachrichten zurück.

PushNotification.prototype.unreadMessagesCount = function( success )

messagesCount

[android, ios]
Gibt die Gesamtzahl der Inbox-Nachrichten zurück.

PushNotification.prototype.messagesCount = function( success )

messagesWithNoActionPerformedCount

[android, ios]
Gibt die Anzahl der Inbox-Nachrichten zurück, für die keine Aktion ausgeführt wurde.

PushNotification.prototype.messagesWithNoActionPerformedCount = function( success )

readMessage

[android, ios]
Markiert eine Inbox-Nachricht als gelesen.

PushNotification.prototype.readMessage = function( number )

deleteMessage

[android, ios]
Löscht eine Nachricht aus der Inbox.

PushNotification.prototype.deleteMessage = function( number )

performAction

[android, ios]
Führt die einer Inbox-Nachricht zugewiesene Aktion aus, z. B. das Öffnen einer URL.

PushNotification.prototype.performAction = function( number )

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 Benachrichtigungs-Payload

ios – (object) iOS-spezifische Benachrichtigungs-Payload

windows – (object) Windows-spezifische Benachrichtigungs-Payload

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));
    }
  }
);

Vordergrundbenachrichtigungen

Standardmäßig zeigt das Pushwoosh-Plugin keine Benachrichtigungen im Vordergrund an und löst automatisch das push-receive-Ereignis aus. Informationen zur Steuerung dieses Verhaltens finden Sie im Leitfaden zur Plugin-Anpassung.

push-notification

[android, ios, wp8, windows]
Ereignis zur Annahme von Push-Benachrichtigungen. 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('user data: ' + JSON.stringify(userData));
    }
  }
);

Ereigniseigenschaften

Gleich wie bei push-receive

additionalAuthorizationOptions

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

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.
});