Questa pagina è stata utile?
I suggerimenti relativi al contenuto di questa pagina sono importanti. Comunicaceli.
Altri suggerimenti?
1500 caratteri rimanenti
Esporta (0) Stampa
Espandi tutto

oggetto wns

Aggiornamento: giugno 2015

Consente di inviare notifiche push a un'app di Windows Store o di Windows universale da script del server di Servizi mobili di Microsoft Azure tramite Hub di notifica di Azure.

createNativeRegistration(channel, tags, optionsOrCallback, callback)
Crea una registrazione di Servizi notifica Push Windows (WNS) nativa.

Parametri

Nome Tipo Argomento Descrizione

channel

string

URI del canale del dispositivo.

tags

stringa | matrice

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

options

object

<facoltativo>

Opzioni della richiesta o callback.

callback

object

<facoltativo>

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

createOrUpdateNativeRegistration(registrationId, channel, tags, optionsOrCallback, callback)
Crea o aggiorna una registrazione di Servizi notifica Push Windows (WNS) nativa.

Parametri

Nome Tipo Argomento Descrizione

registrationId

string

Identificatore della registrazione.

channel

string

URI del canale del dispositivo.

tags

stringa | matrice

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

options

object

<facoltativo>

Opzioni della richiesta o callback.

callback

object

<facoltativo>

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

createOrUpdateRawTemplateRegistration(registrationId, channel, tags, template, optionsOrCallback, callback)
Crea o aggiorna una registrazione di modello personalizzata. Usare questo metodo per ottenere il controllo completo sul formato del modello. È necessario specificare anche l'intestazione X-WNS-Type (valori possibili: wns/toast, wns/tile, wns/badge, wns/raw).

Parametri

Nome Tipo Argomento Descrizione

registrationId

string

Identificatore della registrazione.

channel

string

URI del canale del dispositivo.

tags

stringa | matrice

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

template

string

Modello XML per la registrazione

options

object

<facoltativo>

Opzioni della richiesta o callback.

Proprietà

Nome Tipo Argomento Descrizione

pnsCredentialName

object

<facoltativo>

Credenziali per Servizi di notifica push da usare.

headers

object

<facoltativo>

Intestazioni per Servizi notifica Push Windows da includere.

callback

object

<facoltativo>

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

createRawTemplateRegistration(channel, tags, template, optionsOrCallback, callback)
Crea una registrazione di modello personalizzata. Usare questo metodo per ottenere il controllo completo sul formato del modello. È necessario specificare anche l'intestazione X-WNS-Type (valori possibili: wns/toast, wns/tile, wns/badge, wns/raw).

Parametri

Nome Tipo Argomento Descrizione

channel

string

URI del canale del dispositivo.

tags

stringa | matrice

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

template

string

Modello XML per la registrazione

options

object

<facoltativo>

Opzioni della richiesta o callback.

Proprietà

Nome Tipo Argomento Descrizione

pnsCredentialName

object

<facoltativo>

Credenziali per Servizi di notifica push da usare.

headers

object

<facoltativo>

Intestazioni per Servizi notifica Push Windows da includere.

callback

object

<facoltativo>

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

createTile*Registration(channel, tags, template, options, callback)
Crea una nuova registrazione con un modello di riquadro. Esiste un metodo per ogni modello di riquadro nel Catalogo dei modelli di riquadro, ad esempio createTileSquarePeekImageAndText01Registration.

Parametri

Nome Tipo Argomento Descrizione

channel

string

URI del canale del dispositivo.

tags

stringa | matrice

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

template

object

Modello di corpo della registrazione

Proprietà

Nome Tipo Descrizione

text{1..n}

string

Valore dell'elemento testo con ID specificato, ad esempio text1. Il numero di proprietà text* dipende dal tipo di riquadro.

image{1..n}src

string

Valore dell'attributo src dell'elemento immagine con ID specificato, ad esempio image1. Il numero di proprietà image* dipende dal tipo di riquadro.

image{1..n}alt

string

Valore dell'attributo alt dell'elemento immagine con ID specificato, ad esempio image1. Il numero di proprietà image* dipende dal tipo di riquadro.

lang

string

Valore della lingua dell'elemento binding.

options

object

<facoltativo>

Opzioni della richiesta o callback.

Proprietà

Nome Tipo Argomento Descrizione

headers

object

<facoltativo>

Intestazioni per Servizi notifica Push Windows da includere.

callback

object

<facoltativo>

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

createToast*Registration(channel, tags, template, options, callback)
Crea una nuova registrazione con un modello di avviso popup. Esiste un metodo per ogni modello di avviso popup nel Catalogo dei modelli di avviso popup, ad esempio createToastText01Registration.

Parametri

Nome Tipo Argomento Descrizione

channel

string

URI del canale del dispositivo.

tags

stringa | matrice

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

template

object

Modello di corpo della registrazione

Proprietà

Nome Tipo Descrizione

text{1..n}

string

Valore dell'elemento testo con ID specificato, ad esempio text1. Il numero di proprietà text* dipende dal tipo di avviso popup.

image{1..n}src

string

Valore dell'attributo src dell'elemento immagine con ID specificato, ad esempio image1. Il numero di proprietà image* dipende dal tipo di avviso popup.

image{1..n}alt

string

Valore dell'attributo alt dell'elemento immagine con ID specificato, ad esempio image1. Il numero di proprietà image* dipende dal tipo di avviso popup.

lang

string

Valore della lingua dell'elemento binding.

options

object

<facoltativo>

Opzioni della richiesta o callback.

Proprietà

Nome Tipo Argomento Descrizione

headers

object

<facoltativo>

Intestazioni per Servizi notifica Push Windows da includere.

callback

object

<facoltativo>

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

listRegistrationsByChannel(channel, optionsOrCallback, callback)
Recupera le registrazioni in base all'URI del canale.

Parametri

Nome Tipo Argomento Descrizione

channel

string

URI del canale 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(tags, payload, type, optionsOrCallback, callback)
Invia una notifica di Servizi notifica Push Windows personalizzata. Usare questo metodo per ottenere il controllo completo sul payload.

Parametri

Nome Tipo Argomento Descrizione

tags

matrice | stringa

Singolo tag, espressione di tag o matrice di tag.

payload

string

Payload XML per il messaggio.

type

string

Tipo di messaggio. Corrisponde all'intestazione X-WNS-Type (le opzioni sono: wns/raw, wns/tile e wns/toast).

optionsOrCallback

object

<facoltativo>

Opzioni della richiesta o callback.

Proprietà

Nome Tipo Argomento Descrizione

headers

object

<facoltativo>

Intestazioni per Servizi notifica Push Windows da includere.

callback

object

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

sendBadge(tags, value, optionsOrCallback, callback)
Invia una notifica di Servizi notifica Push Windows di tipo wns/badge.

Parametri

Nome Tipo Argomento Descrizione

tags

matrice | stringa

Elenco separato da virgole o matrice di identificatori di tag.

value

object | string

Valore numerico o valore stringa che specifica il glifo predefinito del badge. Numericamente, questo valore può accettare qualsiasi numero intero valido. Il valore 0 cancella il contenuto del badge, i valori compresi tra 1 e 99 vengono visualizzati come specificato e qualsiasi valore maggiore di 99 viene visualizzato come 99+. Per altre informazioni, vedere l'argomento dell'elemento badge.

optionsOrCallback

object

<facoltativo>

Opzioni della richiesta o callback.

Proprietà

Nome Tipo Argomento Descrizione

headers

object

<facoltativo>

Intestazioni per Servizi notifica Push Windows da includere.

callback

object

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

sendRaw(tags, payload, optionsOrCallback, callback)
Invia una notifica di Servizi notifica Push Windows di tipo wns/raw.

Parametri

Nome Tipo Argomento Descrizione

tags

matrice | stringa

Elenco separato da virgole o matrice di identificatori di tag.

payload

object | string

Payload non elaborato.

optionsOrCallback

object

<facoltativo>

Opzioni della richiesta o callback.

Proprietà

Nome Tipo Argomento Descrizione

headers

object

<facoltativo>

Intestazioni per Servizi notifica Push Windows da includere.

callback

object

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

sendTile*(tags, payload, options, callback)
Invia una notifica di tipo riquadro. Esiste un metodo per ogni modello di riquadro nel Catalogo dei modelli di riquadro, ad esempio sendTileSquarePeekImageAndText01.

Parametri

Nome Tipo Argomento Descrizione

tags

stringa | matrice

Singolo tag o espressione tag.

payload

object

Payload del messaggio. È possibile passare più parametri di payload.

Proprietà

Nome Tipo Descrizione

text{1..n}

string

Valore dell'elemento testo con ID specificato, ad esempio text1. Il numero di proprietà text* dipende dal tipo di riquadro.

image{1..n}src

string

Valore dell'attributo src dell'elemento immagine con ID specificato, ad esempio image1. Il numero di proprietà image* dipende dal tipo di riquadro.

image{1..n}alt

string

Valore dell'attributo alt dell'elemento immagine con ID specificato, ad esempio image1. Il numero di proprietà image* dipende dal tipo di riquadro.

lang

string

Valore della lingua dell'elemento binding.

tipo

string

Usata nel metodo sendTile generale.

options

object

<facoltativo>

Opzioni della richiesta o callback.

Proprietà

Nome Tipo Argomento Descrizione

headers

object

<facoltativo>

Intestazioni per Servizi notifica Push Windows da includere.

callback

object

<facoltativo>

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

sendToast*(tags, payload, options, callback)
Invia una notifica di tipo avviso popup. Esiste un metodo per ogni modello di avviso popup nel Catalogo dei modelli di avviso popup, ad esempio sendToastText01.

Parametri

Nome Tipo Argomento Descrizione

tags

stringa | matrice

Singolo tag o espressione tag.

payload

object

Payload del messaggio.

Proprietà

Nome Tipo Descrizione

text{1..n}

string

Valore dell'elemento testo con ID specificato, ad esempio text1. Il numero di proprietà text* dipende dal tipo di avviso popup.

image{1..n}src

string

Valore dell'attributo src dell'elemento immagine con ID specificato, ad esempio image1. Il numero di proprietà image* dipende dal tipo di avviso popup.

image{1..n}alt

string

Valore dell'attributo alt dell'elemento immagine con ID specificato, ad esempio image1. Il numero di proprietà image* dipende dal tipo di avviso popup.

lang

string

Valore della lingua dell'elemento binding.

options

object

<facoltativo>

Opzioni della richiesta o callback.

Proprietà

Nome Tipo Argomento Descrizione

headers

object

<facoltativo>

Intestazioni per Servizi notifica Push Windows da includere.

callback

object

<facoltativo>

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

updatesRawTemplateRegistration(registrationId, channel, tags, template, optionsOrCallback, callback)
Aggiorna una registrazione del modello non elaborato esistente.

Parametri

Nome Tipo Argomento Descrizione

registrationId

string

Identificatore della registrazione.

channel

string

URI del canale del dispositivo.

tags

stringa | matrice

Tag per la registrazione.

template

stringa | matrice

Modello non elaborato per la registrazione.

options

object

<facoltativo>

Opzioni della richiesta o callback.

Proprietà

Nome Tipo Argomento Descrizione

pnsCredentialName

object

<facoltativo>

Credenziali per Servizi di notifica push da usare.

headers

object

<facoltativo>

Intestazioni per Servizi notifica Push Windows da includere.

etag

object

<facoltativo>

ETag da includere.

callback

object

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

updateTile*Registration(registrationId, channel, tags, template, options, callback)
Aggiorna una registrazione del modello esistente con un nuovo modello di riquadro. Esiste un metodo per ogni modello di riquadro nel Catalogo dei modelli di riquadro, ad esempio updadteTileSquarePeekImageAndText01Registration.

Parametri

Nome Tipo Argomento Descrizione

registrationId

string

Identificatore della registrazione.

channel

string

URI del canale del dispositivo.

tags

stringa | matrice

Tag per la registrazione.

template

object

Modello di corpo della registrazione

Proprietà

Nome Tipo Descrizione

text{1..n}

string

Valore dell'elemento testo con ID specificato, ad esempio text1. Il numero di proprietà text* dipende dal tipo di riquadro.

image{1..n}src

string

Valore dell'attributo src dell'elemento immagine con ID specificato, ad esempio image1. Il numero di proprietà image* dipende dal tipo di riquadro.

image{1..n}alt

string

Valore dell'attributo alt dell'elemento immagine con ID specificato, ad esempio image1. Il numero di proprietà image* dipende dal tipo di riquadro.

lang

string

Valore della lingua dell'elemento binding.

options

object

<facoltativo>

Opzioni della richiesta o callback.

Proprietà

Nome Tipo Argomento Descrizione

headers

object

<facoltativo>

Intestazioni per Servizi notifica Push Windows da includere.

callback

object

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

updateToast*Registration(registrationId, channel, tags, template, options, callback)
Aggiorna una registrazione di modello esistente con un nuovo modello di avviso popup. Esiste un metodo per ogni modello di avviso popup nel Catalogo dei modelli di avviso popup, ad esempio updateToastText01Registration.

Parametri

Nome Tipo Argomento Descrizione

registrationId

string

Identificatore della registrazione.

channel

string

URI del canale del dispositivo.

tags

stringa | matrice

Tag per la registrazione.

template

object

Modello di corpo della registrazione

Proprietà

Nome Tipo Descrizione

text{1..n}

string

Valore dell'elemento testo con ID specificato, ad esempio text1. Il numero di proprietà text* dipende dal tipo di avviso popup.

image{1..n}src

string

Valore dell'attributo src dell'elemento immagine con ID specificato, ad esempio image1. Il numero di proprietà image* dipende dal tipo di avviso popup.

image{1..n}alt

string

Valore dell'attributo alt dell'elemento immagine con ID specificato, ad esempio image1. Il numero di proprietà image* dipende dal tipo di avviso popup.

lang

string

Valore della lingua dell'elemento binding.

options

object

<facoltativo>

Opzioni della richiesta o callback.

Proprietà

Nome Tipo Argomento Descrizione

headers

object

<facoltativo>

Intestazioni per Servizi notifica Push Windows da includere.

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 di Windows, vedere Aggiungere notifiche push all'app di Servizi mobili (Windows Store C#/Windows Store JavaScript/universal Windows C#/universal Windows JavaScript).

Tutti i metodi restituiscono undefined.

Per l'oggetto payload valgono le considerazioni seguenti rispetto alla denominazione e all'ordine dei campi in base al modello specifico:

  • textN specifica il valore stringa del Nmo campo di testo nell'ordine del documento, a partire da 1.

  • imageNsrc specifica l'URL della Nma immagine nell'ordine del documento, a partire da 1.

  • imageNalt specifica il testo alt della Nma immagine nell'ordine del documento, a partire da 1.

  • Gli eventuali campi mancanti vengono considerati stringhe vuote.

  • Eventuali campi aggiuntivi non richiesti da un modello specifico vengono ignorati.

Quando si chiama il metodo sendRaw, il payload di notifica viene recapitato all'app e non viene visualizzato nell'interfaccia utente. Per altre informazioni, vedere Raw notification overview (Windows Store apps).

Lo script seguente usa la funzione send nell'oggetto wns per inviare una notifica di tipo avviso popup a App di Windows Store.

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

Tramite lo script seguente viene chiamato il metodo sendRaw dell'oggetto wns per inviare una notifica di avviso di tipo popup utilizzando il modello ToastImageAndText03.

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

Mostra:
© 2015 Microsoft