(0) exportieren Drucken
Alle erweitern

wns-Objekt

Letzte Aktualisierung: März 2012

Macht die Funktionalität des Windows-Benachrichtigungsdiensts (Windows Notification Service, WNS) in Windows Azure Mobile Services-Serverskripts verfügbar.

Dieses Objekt enthält die folgenden Methoden und Methodensätze, die zum Senden von Benachrichtigungen verwendet werden:

sendTile*

Sendet eine Kachelbenachrichtigung an einen bestimmten Kanal, wobei jede Version der sendTile*-Methode eine andere WNS-Kachelvorlage verwendet.

Syntax

Parameter

 

Parameter Beschreibung

channel

Erforderlicher Kanal-URI-Wert oder Array der URI-Werte, das die Kanäle angibt, die die Benachrichtigung empfangen sollen.

payload

Erforderliches Objekt, das die Benachrichtigungsinformationen enthält, wobei die erforderlichen Felder auf der Popupvorlage der jeweiligen Benachrichtigung basieren. Wenn Sie beispielsweise die sendTileWideImageAndText02-Methode aufrufen, geben Sie ein payload-Objekt mit den folgenden Feldern an:

{
    text1: 'text field 1',
    text2: 'text field 2',
    image1src: 'image1.png',
    image1alt: 'alt text'
}

Siehe die Hinweise für Informationen zur Benennung und Anordnung von Feldern im payload-Objekt.

options

Objekt, das zum Bereitstellen der Erfolgs- und Fehlerrückrufe und anderer optionaler Verhaltensweisen der Benachrichtigung verwendet wird:

{
    success: success,
    error: error,
    headers: wns_headers 
}

Hierbei ist success die Funktion, die nach dem Senden der Benachrichtigung aufgerufen wird, error die Funktion, die bei Auftreten eines Fehlers aufgerufen wird, und headers die Liste aller zusätzlichen HTTP-Anforderungsheader, die in die Anforderung eingeschlossen werden sollen, die an WNS gesendet wird.

Eine Liste der verfügbaren HTTP-Anforderungsheader finden Sie unter Push notification service request and response headers.

Rückgabewert

Nicht definiert.

sendToast*

Sendet eine Popupbenachrichtigung an einen bestimmten Kanal, wobei jede Version der sendToast*-Methode eine andere Popupvorlage verwendet.

Syntax

wns.sendToast*(channel, payload, options)

Das Sternchen (*) ist ein Platzhalter für eine der Vorlagen, wie im Folgenden gezeigt:

Parameter

 

Parameter Beschreibung

channel

Erforderlicher Kanal-URI-Wert oder Array der URI-Werte, das die Kanäle angibt, die die Benachrichtigung empfangen sollen.

payload

Erforderliches Objekt, das die Benachrichtigungsinformationen enthält, wobei die erforderlichen Felder auf der Popupvorlage der jeweiligen Benachrichtigung basieren. Wenn Sie beispielsweise die sendToastImageAndText03-Methode aufrufen, geben Sie ein payload-Objekt mit den folgenden Feldern an:

{
    text1: 'headline text',
    text2: 'body text',
    image1src: 'image1.png',
    image1alt: 'alt text'
}

Siehe die Hinweise für Informationen zur Benennung und Anordnung von Feldern im payload-Objekt.

options

Objekt, das zum Bereitstellen der Erfolgs- und Fehlerrückrufe und anderer optionaler Verhaltensweisen der Benachrichtigung verwendet wird:

{
    success: success,
    error: error,
    headers: wns_headers, 
    launch: launch_uri,
    duration: duration_time 
}

Wobei success die Funktion ist, die nach dem Senden der Benachrichtigung aufgerufen wird, error die Funktion, die bei Auftreten eines Fehlers aufgerufen wird, headers die Liste aller zusätzlichen HTTP-Anforderungsheader, die in die Anforderung eingeschlossen werden sollen, die an WNS gesendet wird, launch_uri eine optionale URI, zu der beim Auslösen der Popupbenachrichtigung navigiert wird, und duration_time der Zeitraum, für den die Popupbenachrichtigung angezeigt wird.

Eine Liste der verfügbaren HTTP-Anforderungsheader finden Sie unter Push notification service request and response headers.

Gültige Werte für das duration_time-Feld sind long und short.

Rückgabewert

Nicht definiert.

sendBadge

Sendet eine Signalbenachrichtigung an einen bestimmten Kanal.

Syntax

wns.sendBadge(channel, value, options)

Parameter

 

Parameter Beschreibung

channel

Erforderlicher Kanal-URI-Wert oder Array der URI-Werte, das die Kanäle angibt, die die Benachrichtigung empfangen sollen.

value

Entweder ein numerischer Wert oder ein Zeichenfolgenwert, der ein vordefiniertes Signalsymbol angibt. In numerischer Form unterstützt dieser Werte eine beliebige gültige ganze Zahl. Der Wert 0 löscht das Signal, die Werte 1 bis 99 werden wie angegeben angezeigt, und alle Werte größer als 99 werden als 99+ angezeigt. Zu den unterstützten Zeichenfolgenwerten gehören die folgenden:

  • none

  • activity

  • alert

  • available

  • away

  • busy

  • newMessage

  • paused

  • playing

  • unavailable

  • error

  • attention

Weitere Informationen finden Sie unter Badge schema.

options

Objekt, das zum Bereitstellen der Erfolgs- und Fehlerrückrufe und anderer optionaler Verhaltensweisen der Benachrichtigung verwendet wird:

{
    success: success,
    error: error,
    headers: wns_headers, 
}

Hierbei ist success die Funktion, die nach dem Senden der Benachrichtigung aufgerufen wird, error die Funktion, die bei Auftreten eines Fehlers aufgerufen wird, und headers die Liste aller zusätzlichen HTTP-Anforderungsheader, die in die Anforderung eingeschlossen werden sollen, die an WNS gesendet wird.

Eine Liste der verfügbaren HTTP-Anforderungsheader finden Sie unter Push notification service request and response headers.

Rückgabewert

Nicht definiert.

sendRaw

Sendet eine unformatierte Benachrichtigung an einen bestimmten Kanal.

Syntax

wns.sendRaw(channel, value, options)

Parameter

 

Parameter Beschreibung

channel

Erforderlicher Kanal-URI-Wert oder Array der URI-Werte, das die Kanäle angibt, die die Benachrichtigung empfangen sollen.

value

Eine anwendungsspezifische Zeichenfolge, die dem Client ohne Änderung übermittelt wird.

options

Objekt, das zum Bereitstellen der Erfolgs- und Fehlerrückrufe und anderer optionaler Verhaltensweisen der Benachrichtigung verwendet wird:

{
    success: success,
    error: error,
    headers: wns_headers, 
}

Hierbei ist success die Funktion, die nach dem Senden der Benachrichtigung aufgerufen wird, error die Funktion, die bei Auftreten eines Fehlers aufgerufen wird, und headers die Liste aller zusätzlichen HTTP-Anforderungsheader, die in die Anforderung eingeschlossen werden sollen, die an WNS gesendet wird.

Eine Liste der verfügbaren HTTP-Anforderungsheader finden Sie unter Push notification service request and response headers.

Rückgabewert

Nicht definiert.

send

Sendet eine vorformatierte Benachrichtigung an einen bestimmten Kanal.

ImportantWichtig
Wenn Sie diese Methode verwenden möchten, müssen Sie das spezifische Nutzlastformat des ausgewählten Benachrichtigungstyps kennen.

Syntax

wns.send(channel, payload, type, value, options)

Parameter

 

Parameter Beschreibung

channel

Erforderlicher Kanal-URI-Wert oder Array der URI-Werte, das die Kanäle angibt, die die Benachrichtigung empfangen sollen.

payload

Eine anwendungsspezifische Zeichenfolge, die dem Client ohne Änderung übermittelt wird.

Informationen zu Nutzlastformaten finden Sie in den Themen zu Pushbenachrichtigungen in der Windows Store-Anwendungsdokumentation. Weitere Informationen finden Sie unter The tile template catalog, The toast template catalog und Badge overview.

type

Gibt den Typ der Benachrichtigung als einen der folgenden Zeichenfolgenwerte an:

 

Wert Beschreibung

wns/badge

Eine Benachrichtigung zur Erstellung einer Signalüberlagerung auf der Kachel. Der Content-Type-Header, der in der Benachrichtigungsanforderung enthalten ist, muss auf "text/XML" festgelegt werden.

wns/tile

Eine Benachrichtigung zur Aktualisierung des Kachelinhalts. Der Content-Type-Header, der in der Benachrichtigungsanforderung enthalten ist, muss auf "text/XML" festgelegt werden.

wns/toast

Eine Benachrichtigung zum Auslösen eines Popups auf dem Client. Der Content-Type-Header, der in der Benachrichtigungsanforderung enthalten ist, muss auf "text/XML" festgelegt werden.

wns/raw

Eine Benachrichtigung, die eine benutzerdefinierte Nutzlast enthalten kann und direkt an die Anwendung übermittelt wird. Der Content-Type-Header, der in der Benachrichtigungsanforderung enthalten ist, muss auf "application/octet-stream" festgelegt werden.

options

Objekt, das zum Bereitstellen der Erfolgs- und Fehlerrückrufe und anderer optionaler Verhaltensweisen der Benachrichtigung verwendet wird:

{
    success: success,
    error: error,
    headers: wns_headers, 
}

Hierbei ist success die Funktion, die nach dem Senden der Benachrichtigung aufgerufen wird, error die Funktion, die bei Auftreten eines Fehlers aufgerufen wird, und headers die Liste aller zusätzlichen HTTP-Anforderungsheader, die in die Anforderung eingeschlossen werden sollen, die an WNS gesendet wird.

Eine Liste der verfügbaren HTTP-Anforderungsheader finden Sie unter Push notification service request and response headers.

Rückgabewert

Nicht definiert.

Für das payload-Objekt gelten die folgenden Überlegungen in Bezug auf Benennung und Reihenfolge der Felder auf Grundlage der jeweiligen Vorlage:

  • textN gibt den Zeichenfolgenwert des Nten Textfelds in der Dokumentreihenfolge an, beginnend bei 1.

  • imageNsrc gibt die URL des Nten Bilds in der Dokumentreihenfolge an, beginnend bei 1.

  • imageNalt gibt den alt-Text des Nten Bilds in der Dokumentreihenfolge an, beginnend bei 1.

  • Alle fehlenden Felder werden als leere Zeichenfolgen angesehen.

  • Alle zusätzlichen Felder, die nicht von einer bestimmten Vorlage gefordert werden, werden ignoriert.

Wenn Sie die sendRaw-Methode aufrufen, wird die Benachrichtigungsnutzlast an die Anwendung übermittelt und nicht in der Benutzeroberfläche angezeigt. Weitere Informationen finden Sie unter Raw notification overview (Windows Store apps).

Im folgenden Skript wird das wns-Objekt verwendet, um Popupbenachrichtigungen an eine Windows Store-App zu senden.

function insert(comment, user, request) { 
  request.execute({ 
    success: function() { 
      var sql = "SELECT deviceId FROM devices " + 
      "INNER JOIN posts ON devices.userId = posts.userId " + 
      "WHERE posts._id = ?"; 
      mssql.query(sql, [comment.postId], { 
        success: function(results) { 
          if(results.length > 0) { 
            push.wns.sendToastText04(results[0].deviceId, { 
              text1: comment.username + ' commented on your post!' 
            }); 
          } 
        } 
      }); 
      // Write to the response for the original request while the push notification happens in the background 
      request.respond(); 
    } 
  }); 
}

Das folgende Skript ruft die sendRaw-Methode des wns-Objekts auf, um eine vorformatierte Popupbenachrichtigung unter Verwendung der ToastImageAndText03-Vorlage zu senden.

function insert(item, user, request) {
    request.execute({
        success: function() {
            // Write to the response and then send a raw notification in the background.
            request.respond();
            push.wns.sendRaw(item.channel,'{ notification: raw, text: "Raw notification string" }' + 
            item.text, {
                success: function(pushResponse) {
                    console.log("Sent push:", pushResponse);
                }
            });
        }
    });
}

Das folgende Skript ruft die send-Methode des wns-Objekts auf, um eine vorformatierte Popupbenachrichtigung unter Verwendung der ToastImageAndText03-Vorlage zu senden.

function insert(item, user, request) {
    request.execute({
        success: function() {
            // Write to the response and then send the pre-formatted notification in the background.
            request.respond();
            push.wns.send(item.channel,'<toast launch=""><visual lang="de-DE">' +
            '<binding template="ToastImageAndText03"><image id="1" src="imageUri" />' + 
            '<text id="1">Template: ToastImageAndText03</text>' + 
            '<text id="2">' + item.text + '</text></binding></visual></toast>',
            "wns/toast", {
                success: function(pushResponse) {
                    console.log("Sent push:", pushResponse);
                }
            });
        }
    });
}

Anzeigen:
© 2014 Microsoft