Dieser Artikel wurde maschinell übersetzt. Wenn Sie die englische Version des Artikels anzeigen möchten, aktivieren Sie das Kontrollkästchen Englisch. Sie können den englischen Text auch in einem Popupfenster anzeigen, indem Sie den Mauszeiger über den Text bewegen.
Übersetzung
Englisch

WNS-Objekt

 

Ermöglicht das Senden von Pushbenachrichtigungen zu einer Windows Store oder universelle Windows-app aus Microsoft Azure Mobile Services Serverskripts Azure Notification Hubs verwenden.

createNativeRegistration(channel, tags, optionsOrCallback, callback)

Erstellt eine systemeigene WNS-Registrierung.

Parameter

Name

Type

Argument

Beschreibung

channel

Zeichenfolge

Der Gerätekanal-URI.

tags

string | array

Ein einzelnes Tag oder ein Array von Tags (durch Trennzeichen getrennte Liste, keine Leerzeichen).

options

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

callback

object

< optionale >

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

createOrUpdateNativeRegistration(registrationId, channel, tags, optionsOrCallback, callback)

Erstellt oder aktualisiert eine systemeigene WNS-Registrierung.

Parameter

Name

Type

Argument

Beschreibung

registrationId

Zeichenfolge

Der Registrierungsbezeichner.

channel

Zeichenfolge

Der Gerätekanal-URI.

tags

string | array

Ein einzelnes Tag oder ein Array von Tags (durch Trennzeichen getrennte Liste, keine Leerzeichen).

options

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

callback

object

< optionale >

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

createOrUpdateRawTemplateRegistration(registrationId, channel, tags, template, optionsOrCallback, callback)

Erstellt oder aktualisiert eine benutzerdefinierte Vorlagenregistrierung. Mit dieser Methode haben Sie die vollständige Kontrolle über das Vorlagenformat. Sie müssen auch angeben, die X-WNS-Type Header (mögliche Werte: wns/toast, wns/tile, wns/badge, wns/raw).

Parameter

Name

Type

Argument

Beschreibung

registrationId

Zeichenfolge

Der Registrierungsbezeichner.

channel

Zeichenfolge

Der Gerätekanal-URI.

tags

string | array

Ein einzelnes Tag oder ein Array von Tags (durch Trennzeichen getrennte Liste, keine Leerzeichen).

template

Zeichenfolge

Die XML-Vorlage für die Registrierung.

options

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

Name

Type

Argument

Beschreibung

pnsCredentialName

object

< optionale >

Die zu verwendenden PNS-Anmeldeinformationen.

headers

object

< optionale >

Die einzuschließenden WNS-Header.

callback

object

< optionale >

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

createRawTemplateRegistration(channel, tags, template, optionsOrCallback, callback)

Erstellt eine benutzerdefinierte Vorlagenregistrierung. Mit dieser Methode haben Sie die vollständige Kontrolle über das Vorlagenformat. Sie müssen auch angeben, die X-WNS-Type Header (mögliche Werte: wns/toast, wns/tile, wns/badge, wns/raw).

Parameter

Name

Type

Argument

Beschreibung

channel

Zeichenfolge

Der Gerätekanal-URI.

tags

string | array

Ein einzelnes Tag oder ein Array von Tags (durch Trennzeichen getrennte Liste, keine Leerzeichen).

template

Zeichenfolge

Die XML-Vorlage für die Registrierung.

options

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

Name

Type

Argument

Beschreibung

pnsCredentialName

object

< optionale >

Die zu verwendenden PNS-Anmeldeinformationen.

headers

object

< optionale >

Die einzuschließenden WNS-Header.

callback

object

< optionale >

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

createTile*Registration(channel, tags, template, options, callback)

Erstellt eine neue Registrierung mit einer Kachelvorlage. Es gibt eine Methode für jede kachelvorlage in die Kachel Vorlagenkatalogs, wie z. B. createTileSquarePeekImageAndText01Registration.

Parameter

Name

Type

Argument

Beschreibung

channel

Zeichenfolge

Der Gerätekanal-URI.

tags

string | array

Ein einzelnes Tag oder ein Array von Tags (durch Trennzeichen getrennte Liste, keine Leerzeichen).

template

object

Die Textvorlage der Registrierung.

Name

Type

Beschreibung

text{1..n}

Zeichenfolge

Wert des Textelements mit der ID angegeben wird, wie z. B. text1. Die Anzahl der text* Eigenschaften hängt vom kacheltyp.

image{1..n}src

Zeichenfolge

Der Wert der src Attribut des Image-Elements mit der Id angegeben wird, wie z. B. image1. Die Anzahl der image* Eigenschaften hängt vom kacheltyp.

image{1..n}alt

Zeichenfolge

Der Wert der alt Attribut des Image-Elements mit der Id angegeben wird, wie z. B. image1. Die Anzahl der image* Eigenschaften hängt vom kacheltyp.

lang

Zeichenfolge

Wert der Sprache für das Bindungselement

options

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

Name

Type

Argument

Beschreibung

headers

object

< optionale >

Die einzuschließenden WNS-Header.

callback

object

< optionale >

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

CreateToast * Registrierung (Kanal, Tags, Vorlagen, Optionen, Rückruf)

Erstellt eine neue Registrierung mit einer Popupvorlage. Es ist eine Methode für jede Toast-Vorlage in die Toast Vorlagenkatalogs, wie z. B. createToastText01Registration.

Parameter

Name

Type

Argument

Beschreibung

channel

Zeichenfolge

Der Gerätekanal-URI.

tags

string | array

Ein einzelnes Tag oder ein Array von Tags (durch Trennzeichen getrennte Liste, keine Leerzeichen).

template

object

Die Textvorlage der Registrierung.

Name

Type

Beschreibung

text{1..n}

Zeichenfolge

Wert des Textelements mit der ID angegeben wird, wie z. B. text1. Die Anzahl der text* Eigenschaften hängt vom Popup-Typ.

image{1..n}src

Zeichenfolge

Der Wert der src Attribut des Image-Elements mit der Id angegeben wird, wie z. B. image1. Die Anzahl der image* Eigenschaften hängt vom Popup-Typ.

image{1..n}alt

Zeichenfolge

Der Wert der alt Attribut des Image-Elements mit der Id angegeben wird, wie z. B. image1. Die Anzahl der image* Eigenschaften hängt vom Popup-Typ.

lang

Zeichenfolge

Wert der Sprache für das Bindungselement

options

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

Name

Type

Argument

Beschreibung

headers

object

< optionale >

Die einzuschließenden WNS-Header.

callback

object

< optionale >

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

ListRegistrationsByChannel (Channel, OptionsOrCallback, Rückruf)

Ruft Registrierungen durch den Kanal-URI ab.

Parameter

Name

Type

Argument

Beschreibung

channel

Zeichenfolge

Der Gerätekanal-URI.

options

object

< optionale >

Anforderungsoptionen oder Rückruffunktion Weitere Eigenschaften werden als Header übergegeben.

Name

Type

Argument

Beschreibung

Oben

object

< optionale >

Legt die maximale Anzahl von Registrierungen fest, die im Rückruf abgerufen werden.

skip

object

< optionale >

Legt die Anzahl von Registrierungen, die im Aufruf übersprungen werden, fest.

callback

object

< optionale >

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

send(tags, payload, type, optionsOrCallback, callback)

Sendet eine benutzerdefinierte WNS-Benachrichtigung. Mit dieser Methode haben Sie die vollständige Kontrolle über die Nutzlast.

Parameter

Name

Type

Argument

Beschreibung

tags

array | string

Einzelnes Tag, Tagausdruck oder Array von Tags

payload

Zeichenfolge

Die XML-Nutzlast für die Nachricht.

type

Zeichenfolge

Der Nachrichtentyp. X-WNS-Type-Header entspricht (Optionen sind: wns/raw, wns/tile und wns/toast).

optionsOrCallback

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

Name

Type

Argument

Beschreibung

headers

object

< optionale >

Die einzuschließenden WNS-Header.

callback

object

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

sendBadge(tags, value, optionsOrCallback, callback)

Sendet eine WNS-Benachrichtigung vom Typ "wns/badge".

Parameter

Name

Type

Argument

Beschreibung

tags

array | string

Durch Trennzeichen getrennte Liste oder Array von Tagbezeichnern.

value

Objekt | Zeichenfolge

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. Weitere Informationen finden Sie in der Badge-Element Thema.

optionsOrCallback

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

Name

Type

Argument

Beschreibung

headers

object

< optionale >

Die einzuschließenden WNS-Header.

callback

object

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

sendRaw(tags, payload, optionsOrCallback, callback)

Sendet eine WNS-Benachrichtigung vom Typ "wns/raw".

Parameter

Name

Type

Argument

Beschreibung

tags

array | string

Durch Trennzeichen getrennte Liste oder Array von Tagbezeichnern.

payload

Objekt | Zeichenfolge

Die Raw-Nutzlast.

optionsOrCallback

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

Name

Type

Argument

Beschreibung

headers

object

< optionale >

Die einzuschließenden WNS-Header.

callback

object

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

Sich * (Tags, Payload, Optionen, Rückruf)

Sendet eine Kachelbenachrichtigung. Es gibt eine Methode für jede kachelvorlage in die Kachel Vorlagenkatalogs, wie z. B. sendTileSquarePeekImageAndText01.

Parameter

Name

Type

Argument

Beschreibung

tags

string | array

Einzelnes Tag oder Tagausdruck

payload

object

Die Nachrichtennutzlast Es können mehrere Nutzlastparameter übergeben werden.

Name

Type

Beschreibung

text{1..n}

Zeichenfolge

Wert des Textelements mit der ID angegeben wird, wie z. B. text1. Die Anzahl der text* Eigenschaften hängt vom kacheltyp.

image{1..n}src

Zeichenfolge

Der Wert der src Attribut des Image-Elements mit der Id angegeben wird, wie z. B. image1. Die Anzahl der image* Eigenschaften hängt vom kacheltyp.

image{1..n}alt

Zeichenfolge

Der Wert der alt Attribut des Image-Elements mit der Id angegeben wird, wie z. B. image1. Die Anzahl der image* Eigenschaften hängt vom kacheltyp.

lang

Zeichenfolge

Wert der Sprache für das Bindungselement

Type

Zeichenfolge

Allgemein verwendete sendTile Methode.

options

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

Name

Type

Argument

Beschreibung

headers

object

< optionale >

Die einzuschließenden WNS-Header.

callback

object

< optionale >

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

sendToast*(tags, payload, options, callback)

Sendet eine Popupbenachrichtigung. Es ist eine Methode für jede Toast-Vorlage in die Toast Vorlagenkatalogs, wie z. B. sendToastText01.

Parameter

Name

Type

Argument

Beschreibung

tags

string | array

Einzelnes Tag oder Tagausdruck

payload

object

Die Nachrichtennutzlast

Name

Type

Beschreibung

text{1..n}

Zeichenfolge

Wert des Textelements mit der ID angegeben wird, wie z. B. text1. Die Anzahl der text* Eigenschaften hängt vom Popup-Typ.

image{1..n}src

Zeichenfolge

Der Wert der src Attribut des Image-Elements mit der Id angegeben wird, wie z. B. image1. Die Anzahl der image* Eigenschaften hängt vom Popup-Typ.

image{1..n}alt

Zeichenfolge

Der Wert der alt Attribut des Image-Elements mit der Id angegeben wird, wie z. B. image1. Die Anzahl der image* Eigenschaften hängt vom Popup-Typ.

lang

Zeichenfolge

Wert der Sprache für das Bindungselement

options

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

Name

Type

Argument

Beschreibung

headers

object

< optionale >

Die einzuschließenden WNS-Header.

callback

object

< optionale >

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

updatesRawTemplateRegistration(registrationId, channel, tags, template, optionsOrCallback, callback)

Aktualisiert eine vorhandene Raw-Vorlagenregistrierung.

Parameter

Name

Type

Argument

Beschreibung

registrationId

Zeichenfolge

Der Registrierungsbezeichner.

channel

Zeichenfolge

Der Gerätekanal-URI.

tags

string | array

Tags für die Registrierung.

template

string | array

Die Raw-Vorlage für die Registrierung.

options

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

Name

Type

Argument

Beschreibung

pnsCredentialName

object

< optionale >

Die zu verwendenden PNS-Anmeldeinformationen.

headers

object

< optionale >

Die einzuschließenden WNS-Header.

etag

object

< optionale >

Das ETag, das miteingeschlossen wird.

callback

object

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

updateTile*Registration(registrationId, channel, tags, template, options, callback)

Aktualisiert eine vorhandene Vorlagenregistrierung mit einer neuen Kachelvorlage. Es gibt eine Methode für jede kachelvorlage in die Kachel Vorlagenkatalogs, wie z. B. updadteTileSquarePeekImageAndText01Registration.

Parameter

Name

Type

Argument

Beschreibung

registrationId

Zeichenfolge

Der Registrierungsbezeichner.

channel

Zeichenfolge

Der Gerätekanal-URI.

tags

string | array

Tags für die Registrierung.

template

object

Die Textvorlage der Registrierung.

Name

Type

Beschreibung

text{1..n}

Zeichenfolge

Wert des Textelements mit der ID angegeben wird, wie z. B. text1. Die Anzahl der text* Eigenschaften hängt vom kacheltyp.

image{1..n}src

Zeichenfolge

Der Wert der src Attribut des Image-Elements mit der Id angegeben wird, wie z. B. image1. Die Anzahl der image* Eigenschaften hängt vom kacheltyp.

image{1..n}alt

Zeichenfolge

Der Wert der alt Attribut des Image-Elements mit der Id angegeben wird, wie z. B. image1. Die Anzahl der image* Eigenschaften hängt vom kacheltyp.

lang

Zeichenfolge

Wert der Sprache für das Bindungselement

options

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

Name

Type

Argument

Beschreibung

headers

object

< optionale >

Die einzuschließenden WNS-Header.

callback

object

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

updateToast*Registration(registrationId, channel, tags, template, options, callback)

Aktualisiert eine vorhandene Vorlagenregistrierung mit einer neuen Popupvorlage. Es ist eine Methode für jede Toast-Vorlage in die Toast Vorlagenkatalogs, wie z. B. updateToastText01Registration.

Parameter

Name

Type

Argument

Beschreibung

registrationId

Zeichenfolge

Der Registrierungsbezeichner.

channel

Zeichenfolge

Der Gerätekanal-URI.

tags

string | array

Tags für die Registrierung.

template

object

Die Textvorlage der Registrierung.

Name

Type

Beschreibung

text{1..n}

Zeichenfolge

Wert des Textelements mit der ID angegeben wird, wie z. B. text1. Die Anzahl der text* Eigenschaften hängt vom Popup-Typ.

image{1..n}src

Zeichenfolge

Der Wert der src Attribut des Image-Elements mit der Id angegeben wird, wie z. B. image1. Die Anzahl der image* Eigenschaften hängt vom Popup-Typ.

image{1..n}alt

Zeichenfolge

Der Wert der alt Attribut des Image-Elements mit der Id angegeben wird, wie z. B. image1. Die Anzahl der image* Eigenschaften hängt vom Popup-Typ.

lang

Zeichenfolge

Wert der Sprache für das Bindungselement

options

object

< optionale >

Die Anforderungsoptionen oder der Rückruf.

Name

Type

Argument

Beschreibung

headers

object

< optionale >

Die einzuschließenden WNS-Header.

callback

object

Ein JSON-Objekt, der angibt, die success und error Rückruffunktionen.

Ein Beispiel zum Senden von Pushbenachrichtigungen von Ihrem mobile Service an eine Windows-Anwendung finden Sie unter Hinzufügen von Pushbenachrichtigungen zu Ihrer app Mobile Services (Windows Store C#-/Windows Store JavaScript/universelle Windows C#-/universelle Windows JavaScript).

Alle Methoden zurückgeben undefined.

Das payload -Objekt hat die folgenden Aspekte in Bezug auf Benennung und Reihenfolge der Felder auf Grundlage der jeweiligen Vorlage:

  • textN Gibt den Zeichenfolgenwert, der die Nten Textfelds in der Dokumentreihenfolge an, beginnend mit 1.

  • imageNsrc Gibt die URL der Nten Bilds in der Dokumentreihenfolge an, beginnend mit 1.

  • imageNalt Gibt die alt Text, der die Nten Bilds in der Dokumentreihenfolge an, beginnend mit 1.

  • Alle fehlenden Felder werden als leere Zeichenfolgen angesehen.

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

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

Beispiel

Im folgenden Skript wird die send -Funktion auf die wns -Objekt, das eine Toast-Benachrichtigung zu senden einer Windows Store-App.

function insert(item, user, request) { // Define a payload for the Windows Store toast notification. var payload = '<?xml version="1.0" encoding="utf-8"?><toast><visual>' + '<binding template="ToastText01">  <text id="1">' + item.text + '</text></binding></visual></toast>'; request.execute({ success: function() { // If the insert succeeds, send a notification. push.wns.send(null, payload, 'wns/toast', { success: function(pushResponse) { console.log("Sent push:", pushResponse); request.respond(); }, error: function (pushResponse) { console.log("Error Sending push:", pushResponse); request.respond(500, { error: pushResponse }); } }); } }); }

Beispiel

Das folgende Skript ruft die sendRaw Methode der wns -Objekt, das eine vorformatierte Popupbenachrichtigung Senden der ToastImageAndText03 Vorlage.

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(null,'{ notification: raw, text: "Raw notification string" }' + item.text, { success: function(pushResponse) { console.log("Sent push:", pushResponse); } }); } }); }
Anzeigen: