Esporta (0) Stampa
Espandi tutto

oggetto wns

Aggiornamento: marzo 2012

Espone la funzionalità Windows Notification Service (WNS) negli script server dei Servizi mobili di Windows Azure.

Questo oggetto contiene i metodi e i set di metodi seguenti utilizzati per inviare notifiche:

sendTile*

Invia una notifica di tipo riquadro a un canale specifico, dove ogni versione del metodo sendTile* utilizza un modello di riquadro WNS.

Sintassi

Parametri

 

Parameter Descrizione

channel

Valore URI di canale o matrice di valori URI obbligatoria che indica i canali in cui ricevere la notifica.

payload

Oggetto obbligatorio che contiene le informazioni sulla notifica, dove i campi obbligatori sono basati sul modello di avviso di tipo popup della notifica specifica. Ad esempio, quando si chiama il metodo sendTileWideImageAndText02, si specifica un oggetto payload con i campi seguenti:

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

Vedere la sezione osservazioni per informazioni sulla denominazione e l'ordinamento dei campi nell'oggetto payload.

options

Oggetto utilizzato per fornire i callback di esito positivo e negativo e altri comportamenti facoltativi della notifica:

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

Dove success è la funzione chiamata dopo l'invio della notifica, error è la funzione chiamata quando si verifica un errore e headers è un elenco delle intestazioni delle richieste HTTP aggiuntive da includere nella richiesta inviata a WNS.

Per un elenco delle intestazioni delle richieste HTTP, vedere Push notification service request and response headers.

Restituisce

Non definito.

sendToast*

Invia una notifica di tipo avviso popup a un canale specifico, dove ogni versione del metodo sendToast* utilizza un modello di avviso di tipo popup.

Sintassi

wns.sendToast*(channel, payload, options)

L'asterisco (*) è un segnaposto per uno dei modelli di riquadro, come indicato di seguito:

Parametri

 

Parameter Descrizione

channel

Valore URI di canale o matrice di valori URI obbligatoria che indica i canali in cui ricevere la notifica.

payload

Oggetto obbligatorio che contiene le informazioni sulla notifica, dove i campi obbligatori sono basati sul modello di avviso di tipo popup della notifica specifica. Ad esempio, quando si chiama il metodo sendToastImageAndText03, si specifica un oggetto payload con i campi seguenti:

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

Vedere la sezione osservazioni per informazioni sulla denominazione e l'ordinamento dei campi nell'oggetto payload.

options

Oggetto utilizzato per fornire i callback di esito positivo e negativo e altri comportamenti facoltativi della notifica:

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

Dove success è la funzione chiamata dopo l'invio della notifica, error è la funzione chiamata quando si verifica un errore, headers è l'elenco delle intestazioni delle richieste HTTP aggiuntive da includere nella richiesta inviata a WNS, launch_uri è un URI facoltativo da visualizzare quando viene generata la notifica di avviso di tipo popup e duration_time è il periodo di tempo durante il quale viene visualizzata la notifica di avviso di tipo popup.

Per un elenco delle intestazioni delle richieste HTTP, vedere Push notification service request and response headers.

I valori validi per il campo duration_time sono long e short.

Restituisce

Non definito.

sendBadge

Invia una notifica badge a un canale specifico.

Sintassi

wns.sendBadge(channel, value, options)

Parametri

 

Parameter Descrizione

channel

Valore URI di canale o matrice di valori URI obbligatoria che indica i canali in cui ricevere la notifica.

value

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+. I valori stringa supportati includono

  • Nessuno

  • activity

  • avviso

  • disponibile

  • away

  • busy

  • newMessage

  • sospesa

  • playing

  • unavailable

  • error

  • attention

Per ulteriori informazioni, vedere Badge schema.

options

Oggetto utilizzato per fornire i callback di esito positivo e negativo e altri comportamenti facoltativi della notifica:

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

Dove success è la funzione chiamata dopo l'invio della notifica, error è la funzione chiamata quando si verifica un errore e headers è un elenco delle intestazioni delle richieste HTTP aggiuntive da includere nella richiesta inviata a WNS.

Per un elenco delle intestazioni delle richieste HTTP, vedere Push notification service request and response headers.

Restituisce

Non definito.

sendRaw

Invia una notifica non elaborata a un canale specifico.

Sintassi

wns.sendRaw(channel, value, options)

Parametri

 

Parameter Descrizione

channel

Valore URI di canale o matrice di valori URI obbligatoria che indica i canali in cui ricevere la notifica.

value

Stringa specifica dell'applicazione che viene recapitata al client senza modifiche.

options

Oggetto utilizzato per fornire i callback di esito positivo e negativo e altri comportamenti facoltativi della notifica:

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

Dove success è la funzione chiamata dopo l'invio della notifica, error è la funzione chiamata quando si verifica un errore e headers è un elenco delle intestazioni delle richieste HTTP aggiuntive da includere nella richiesta inviata a WNS.

Per un elenco delle intestazioni delle richieste HTTP, vedere Push notification service request and response headers.

Restituisce

Non definito.

send

Invia una notifica pre-formattata a un canale specifico.

ImportantImportante
Per utilizzare questo metodo, è necessario conoscere il formato payload specifico del tipo di notifica selezionato.

Sintassi

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

Parametri

 

Parameter Descrizione

channel

Valore URI di canale o matrice di valori URI obbligatoria che indica i canali in cui ricevere la notifica.

payload

Stringa specifica dell'applicazione che viene recapitata al client senza modifiche.

Vedere gli argomenti relative alle notifiche push nella documentazione delle app Windows Store per informazioni sui formati di payload. Per ulteriori informazioni, vedere The tile template catalog, The toast template catalog e Badge overview.

type

Specifica il tipo di notifica, come uno dei valori stringa seguenti:

 

Valore Descrizione

wns/badge

Notifica per creare un overlay di badge nel riquadro. L'intestazione Content-Type inclusa nella richiesta di notifica deve essere impostata su "text/xml".

wns/tile

Notifica per aggiornare il contenuto del riquadro. L'intestazione Content-Type inclusa nella richiesta di notifica deve essere impostata su "text/xml".

wns/toast

Notifica per generare un avviso di tipo popup nel client. L'intestazione Content-Type inclusa nella richiesta di notifica deve essere impostata su "text/xml".

wns/raw

Notifica che può contenere un payload personalizzato e viene recapitata direttamente all'app. L'intestazione Content-Type inclusa nella richiesta di notifica deve essere impostata su "application/octet-stream".

options

Oggetto utilizzato per fornire i callback di esito positivo e negativo e altri comportamenti facoltativi della notifica:

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

Dove success è la funzione chiamata dopo l'invio della notifica, error è la funzione chiamata quando si verifica un errore e headers è un elenco delle intestazioni delle richieste HTTP aggiuntive da includere nella richiesta inviata a WNS.

Per un elenco delle intestazioni delle richieste HTTP, vedere Push notification service request and response headers.

Restituisce

Non definito.

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 ulteriori informazioni, vedere Raw notification overview (Windows Store apps).

Nello script seguente viene utilizzato l'oggetto wns per inviare notifiche di avviso di tipo popup a un'App di Windows Store.

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

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

Tramite lo script seguente viene chiamato il metodo send 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 the pre-formatted notification in the background.
            request.respond();
            push.wns.send(item.channel,'<toast launch=""><visual lang="en-US">' +
            '<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);
                }
            });
        }
    });
}

Microsoft sta conducendo un sondaggio in linea per comprendere l'opinione degli utenti in merito al sito Web di MSDN. Se si sceglie di partecipare, quando si lascia il sito Web di MSDN verrà visualizzato il sondaggio in linea.

Si desidera partecipare?
Mostra:
© 2014 Microsoft