Esporta (0) Stampa
Espandi tutto

oggetto apns

Aggiornamento: febbraio 2015

Permette di inviare notifiche push a un'app per iOS da script del server di Servizi mobili di Microsoft Azure tramite Hub di notifica di Azure. Il payload per una notifica di Servizi di notifica push di Apple presenta il formato JSON seguente:

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

createNativeRegistration(token, tags, options, callback)
Crea una registrazione di Servizi di notifica push di Apple nativa.

Parametri

Nome Tipo Argomento Descrizione

token

string

Token del dispositivo.

tags

stringa | matrice

Singolo tag o matrice di tag (elenco separato da virgole, senza spazi).

options

object

<facoltativo>

Opzioni della richiesta o funzione di callback.

callback

object

<facoltativo>

Oggetto JSON che specifica le funzioni di callback success e error.

createOrUpdateNativeRegistration(registrationId, token, tags, options, callback)
Crea o aggiorna una registrazione di Servizi di notifica push di Apple nativa.

Parametri

Nome Tipo Argomento Descrizione

registrationId

string

Identificatore della registrazione.

token

string

Token del dispositivo.

tags

stringa | matrice

Singolo tag o matrice di tag (elenco separato da virgole, senza spazi).

options

object

<facoltativo>

Opzioni della richiesta o funzione di callback.

callback

object

<facoltativo>

Oggetto JSON che specifica le funzioni di callback success e error.

createOrUpdateTemplateRegistration(registrationId, token, template, options, callback)
Crea o aggiorna una registrazione di modello.

Parametri

Nome Tipo Argomento Descrizione

registrationId

string

Identificatore della registrazione.

token

string

Token del dispositivo.

template

stringa | matrice

Payload JSON del messaggio, come specificato di seguito.

Proprietà

Nome Tipo Argomento Descrizione

badge

number

<facoltativo>

Numero da visualizzare sull'icona dell'app.

alert

string

<facoltativo>

Testo dell'avviso.

sound

string

<facoltativo>

Nome del file audio.

payload

object

<facoltativo>

Oggetto payload che contiene il testo della notifica.

expiry

date

<facoltativo>

Data di scadenza.

Quando il payload è una stringa, seguire il formato di Servizi di notifica push di Apple.

options

object

<facoltativo>

Opzioni della richiesta o funzione di callback.

callback

object

<facoltativo>

Oggetto JSON che specifica le funzioni di callback success e error.

createTemplateRegistration(token, tags, template, options, callback)
Crea una registrazione del modello.

Parametri

Nome Tipo Argomento Descrizione

token

string

Token del dispositivo.

tags

stringa | matrice

Singolo tag o matrice di tag (elenco separato da virgole, senza spazi).

template

stringa | matrice

Payload JSON del messaggio, come specificato di seguito.

Proprietà

Nome Tipo Argomento Descrizione

badge

number

<facoltativo>

Numero da visualizzare sull'icona dell'app.

alert

string

<facoltativo>

Testo dell'avviso.

sound

string

<facoltativo>

Nome del file audio.

payload

object

<facoltativo>

Oggetto payload che contiene il testo della notifica.

expiry

date

<facoltativo>

Data di scadenza.

Quando il payload è una stringa, seguire il formato di Servizi di notifica push di Apple.

options

object

<facoltativo>

Opzioni della richiesta o funzione di callback.

callback

object

<facoltativo>

Oggetto JSON che specifica le funzioni di callback success e error.

listRegistrationsByToken(token, options, callback)
Recupera una registrazione dal token del dispositivo.

Parametri

Nome Tipo Argomento Descrizione

token

string

Token del dispositivo.

options

object

<facoltativo>

Opzioni della richiesta o funzione di callback. Le proprietà aggiuntive sono passate come intestazioni.

Proprietà

Nome Tipo Argomento Descrizione

top

object

<facoltativo>

Specifica il numero massimo di registrazioni da ottenere dalla chiamata.

skip

object

<facoltativo>

Specifica il numero di registrazioni da ignorare nella chiamata.

callback

object

<facoltativo>

Oggetto JSON che specifica le funzioni di callback success e error.

send(tag, payload, callback)
Invia una notifica di Servizi di notifica push di Apple.

Parametri

Nome Tipo Descrizione

tags

string

Singolo tag o espressione tag. Se null, il messaggio verrà inviato a tutte le registrazioni del modello.

payload

object | string

Payload JSON del messaggio, come specificato di seguito.

Proprietà

Nome Tipo Argomento Descrizione

badge

number

<facoltativo>

Numero da visualizzare sull'icona dell'app.

alert

string

<facoltativo>

Testo dell'avviso.

sound

string

<facoltativo>

Nome del file audio.

payload

object

<facoltativo>

Oggetto payload che contiene il testo della notifica.

expiry

date

<facoltativo>

Data di scadenza.

Quando il payload è una stringa, seguire il formato di Servizi di notifica push di Apple.

callback

object

Oggetto JSON che specifica le funzioni di callback success e error.

updateTemplateRegistration(registrationId, token, template, options, callback)
Aggiorna una registrazione di modello esistente.

Parametri

Nome Tipo Argomento Descrizione

registrationId

string

Identificatore della registrazione.

token

string

Token del dispositivo.

template

stringa | matrice

Payload JSON del messaggio, come specificato di seguito.

Proprietà

Nome Tipo Argomento Descrizione

badge

number

<facoltativo>

Numero da visualizzare sull'icona dell'app.

alert

string

<facoltativo>

Testo dell'avviso.

sound

string

<facoltativo>

Nome del file audio.

payload

object

<facoltativo>

Oggetto payload che contiene il testo della notifica.

expiry

date

<facoltativo>

Data di scadenza.

Quando il payload è una stringa, seguire il formato di Servizi di notifica push di Apple.

options

object

<facoltativo>

Opzioni della richiesta.

callback

object

Oggetto JSON che specifica le funzioni di callback success e error.

Per un esempio che illustra come inviare notifiche push dal servizio mobile a un'app per iOS, vedere l'articolo relativo a come aggiungere notifiche push all'app di Servizi mobili.

L'oggetto apns viene ottenuto dall'oggetto push in uno script server. Per un esempio di completamento, vedere Introduzione alle notifiche push.

Il payload per una notifica di Servizi di notifica push di Apple presenta il formato JSON seguente:

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

Quando viene specificato il campo alert dell'oggetto payload, il valore di testo assegnato viene visualizzato come notifica di tipo avviso popup. Questa notifica viene visualizzata anche quando l'app non è in esecuzione. I dati nel campo payload dell'oggetto payload vengono visualizzati solo quando l'app è in esecuzione.

Nell'esempio seguente viene chiamato il metodo send per inviare una notifica di testo in un dispositivo specifico quando un nuovo elemento viene inserito in una tabella.

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

Mostra:
© 2015 Microsoft