(0) exportieren Drucken
Alle erweitern

apns-Objekt

Letzte Aktualisierung: Oktober 2014

Ermöglicht das Senden von Pushbenachrichtigungen an eine iOS-App von Microsoft Azure Mobile Services-Serverskripts aus unter Verwendung von Azure Notification Hubs. Die Nutzlast für eine APNS-Benachrichtigung weist das folgende JSON-Format auf:

{
    aps: {
        badge: badge_number,
        alert: 'alert_text',
        sound: 'sound_file',
        payload: payload_object,
        expiry: expire_date
    }
}

createNativeRegistration(token, tags, options, callback)
Erstellt eine systemeigene APNS-Registrierung.

Parameter

Name Typ Argument Beschreibung

token

Zeichenfolge

Das Gerätetoken.

tags

string | array

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

options

object

<optional>

Anforderungsoptionen oder Rückruffunktion

callback

object

<optional>

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

createOrUpdateNativeRegistration(registrationId, token, tags, options, callback)
Erstellt oder aktualisiert eine systemeigene APNS-Registrierung.

Parameter

Name Typ Argument Beschreibung

registrationId

Zeichenfolge

Der Registrierungsbezeichner.

token

Zeichenfolge

Das Gerätetoken.

tags

string | array

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

options

object

<optional>

Anforderungsoptionen oder Rückruffunktion

callback

object

<optional>

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

createOrUpdateTemplateRegistration(registrationId, token, template, options, callback)
Erstellt oder aktualisiert eine Vorlagenregistrierung.

Parameter

Name Typ Argument Beschreibung

registrationId

Zeichenfolge

Der Registrierungsbezeichner.

token

Zeichenfolge

Das Gerätetoken.

template

string | array

Die JSON-Nutzlast für die Nachricht wie unten angegeben.

Eigenschaften

Name Typ Argument Beschreibung

badge

number

<optional>

Die Zahl, die über dem App-Symbol angezeigt werden soll.

Warnung

Zeichenfolge

<optional>

Der Text der Warnung.

sound

Zeichenfolge

<optional>

Der Name der Audiodatei.

payload

object

<optional>

Das payload-Objekt, das den Benachrichtigungstext enthält.

expiry

date

<optional>

Das Ablaufdatum.

Wenn die Nutzlast eine Zeichenfolge ist, verwenden Sie das APNS-Format.

options

object

<optional>

Anforderungsoptionen oder Rückruffunktion

callback

object

<optional>

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

createTemplateRegistration(token, tags, template, options, callback)
Erstellt eine Vorlagenregistrierung.

Parameter

Name Typ Argument Beschreibung

token

Zeichenfolge

Das Gerätetoken.

tags

string | array

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

template

string | array

Die JSON-Nutzlast für die Nachricht wie unten angegeben.

Eigenschaften

Name Typ Argument Beschreibung

badge

number

<optional>

Die Zahl, die über dem App-Symbol angezeigt werden soll.

Warnung

Zeichenfolge

<optional>

Der Text der Warnung.

sound

Zeichenfolge

<optional>

Der Name der Audiodatei.

payload

object

<optional>

Das payload-Objekt, das den Benachrichtigungstext enthält.

expiry

date

<optional>

Das Ablaufdatum.

Wenn die Nutzlast eine Zeichenfolge ist, verwenden Sie das APNS-Format.

options

object

<optional>

Anforderungsoptionen oder Rückruffunktion

callback

object

<optional>

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

listRegistrationsByToken(token, options, callback)
Ruft eine Registrierung anhand des Gerätetokens ab.

Parameter

Name Typ Argument Beschreibung

token

Zeichenfolge

Das Gerätetoken.

options

object

<optional>

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

Eigenschaften

Name Typ Argument Beschreibung

Oben

object

<optional>

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

skip

object

<optional>

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

callback

object

<optional>

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

send(tags, payload, callback)
Sendet eine APNS-Benachrichtigung.

Parameter

Name Typ Beschreibung

tags

Zeichenfolge

Einzelnes Tag oder Tagausdruck Wenn dieser Parameter auf NULL festgelegt ist, wird die Nachricht an alle Vorlagenregistrierungen gesendet.

payload

Objekt | Zeichenfolge

Die JSON-Nutzlast für die Nachricht wie unten angegeben.

Eigenschaften

Name Typ Argument Beschreibung

badge

number

<optional>

Die Zahl, die über dem App-Symbol angezeigt werden soll.

Warnung

Zeichenfolge

<optional>

Der Text der Warnung.

sound

Zeichenfolge

<optional>

Der Name der Audiodatei.

payload

object

<optional>

Das payload-Objekt, das den Benachrichtigungstext enthält.

expiry

date

<optional>

Das Ablaufdatum.

Wenn die Nutzlast eine Zeichenfolge ist, verwenden Sie das APNS-Format.

callback

object

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

updateTemplateRegistration(registrationId, token, template, options, callback)
Aktualisiert eine vorhandene Vorlagenregistrierung.

Parameter

Name Typ Argument Beschreibung

registrationId

Zeichenfolge

Der Registrierungsbezeichner.

token

Zeichenfolge

Das Gerätetoken.

template

string | array

Die JSON-Nutzlast für die Nachricht wie unten angegeben.

Eigenschaften

Name Typ Argument Beschreibung

badge

number

<optional>

Die Zahl, die über dem App-Symbol angezeigt werden soll.

Warnung

Zeichenfolge

<optional>

Der Text der Warnung.

sound

Zeichenfolge

<optional>

Der Name der Audiodatei.

payload

object

<optional>

Das payload-Objekt, das den Benachrichtigungstext enthält.

expiry

date

<optional>

Das Ablaufdatum.

Wenn die Nutzlast eine Zeichenfolge ist, verwenden Sie das APNS-Format.

options

object

<optional>

Die Anforderungsoptionen

callback

object

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

Unter Erste Schritte mit Pushbenachrichtigungen in Mobile Services finden Sie ein Beispiel dazu, wie Pushbenachrichtigungen von Ihrem mobilen Dienst an eine iOS-App gesendet werden können.

Das apns-Objekt wird vom push-Objekt in einem Serverskript abgerufen. Ein vollständiges Beispiel finden Sie unter Erste Schritte mit Pushbenachrichtigungen.

Die Nutzlast für eine APNS-Benachrichtigung weist das folgende JSON-Format auf:

{
    aps: {
        badge: badge_number,
        alert: 'alert_text',
        sound: 'sound_file',
        payload: payload_object,
        expiry: expire_date
    }
}

Wenn das alert-Feld des payload-Objekts angegeben wird, wird der zugewiesene Textwert als Popupbenachrichtigung angezeigt. Diese Benachrichtigung wird auch dann angezeigt, wenn die Anwendung nicht ausgeführt wird. Die Daten im payload-Feld des payload-Objekts werden nur angezeigt, wenn die Anwendung ausgeführt wird.

Im folgenden Beispiel wird die send-Methode aufgerufen, um eine Textbenachrichtigung an ein bestimmtes Gerät zu senden, wenn ein neues Element in eine Tabelle eingefügt wird.

function insert(item, user, request) {
    request.execute();
    push.apns.send(null, {
        alert: "Alert: " + item.text,
        payload: {
            inAppMessage: "Hey, a new item arrived: '" + item.text + "'"
        }
    });
}

Anzeigen:
© 2014 Microsoft