Modelli di Hub di notifica
I modelli consentono alle applicazioni client di specificare il formato esatto delle notifiche da ricevere. Mediante i modelli, le app possono ottenere diversi vantaggi, fra cui i seguenti:
- Un back-end indipendente dalla piattaforma
- Notifiche personalizzate
- Indipendenza dalla versione del client
- Localizzazione semplice
Questa sezione fornisce due esempi approfonditi di come usare i modelli per inviare notifiche indipendenti dalla piattaforma destinate a tutti i dispositivi tra piattaforme e per personalizzare le notifiche di trasmissione in ogni dispositivo.
Utilizzo di modelli multipiattaforma
Il metodo standard per inviare notifiche push consiste nell'inviare, per ciascuna notifica, uno specifico payload dei servizi di notifica della piattaforma (WNS, servizio APN). Per inviare un avviso al servizio APN, ad esempio, il payload è un oggetto JSON nel formato seguente:
{"aps": {"alert" : "Hello!" }}
Per inviare un messaggio di avviso popup simile in un'applicazione di Windows Store, il payload XML è il seguente:
<toast>
<visual>
<binding template=\"ToastText01\">
<text id=\"1\">Hello!</text>
</binding>
</visual>
</toast>
È possibile creare payload simili per MPNS (Windows Phone) e piattaforme FCM (Android).
Tale requisito impone al back-end dell'app la produzione di payload diversi per ciascuna piattaforma e di fatto rende il back-end responsabile di parte del livello di presentazione dell'app. Alcuni dei problemi riguardano la localizzazione e i layout grafici (soprattutto per applicazioni di Windows Store che comprendono notifiche per vari tipi di riquadri).
La funzionalità del modello degli Hub di notifica consente a un'app client di creare registrazioni speciali, denominate registrazioni con modello, comprendenti un modello, oltre al set di tag. La funzionalità modello hub di notifica consente a un'app client di associare i dispositivi ai modelli, indipendentemente dal fatto che si lavori con installazioni (preferite) o registrazioni. Dato gli esempi di payload precedenti, le uniche informazioni indipendenti dalla piattaforma sono il messaggio di avviso effettivo (Hello!). Un modello è un set di istruzioni per l'hub di notifica su come formattare un messaggio indipendente dalla piattaforma per la registrazione di tale app client specifica. Nell'esempio precedente il messaggio indipendente dalla piattaforma consiste in una singola proprietà: message = Hello!.
Nella figura riportata di seguito viene illustrato il processo:
Il modello per la registrazione dell'app client iOS è il seguente:
{"aps": {"alert": "$(message)"}}
Il modello corrispondente per l'applicazione client di Windows Store è:
<toast>
<visual>
<binding template=\"ToastText01\">
<text id=\"1\">$(message)</text>
</binding>
</visual>
</toast>
Si noti che il messaggio effettivo viene sostituito con l'espressione $(message). Questa espressione indica all'hub di notifica, ogni volta che invia un messaggio a questa registrazione specifica, per compilare un messaggio che lo segue e inserisce il valore comune.
Se si usa il modello di installazione, la chiave "templates" di installazione contiene un codice JSON di più modelli. Se si usa il modello di registrazione, l'applicazione client può creare più registrazioni per usare più modelli; Ad esempio, un modello per i messaggi di avviso e un modello per gli aggiornamenti dei riquadri. Inoltre, le applicazioni client possono unire registrazioni native (registrazioni senza modello) e registrazioni con modello.
L'hub di notifica invia una notifica per ogni modello senza considerare se appartengono alla stessa app client. Questo comportamento può essere utilizzato per convertire notifiche indipendenti dalla piattaforma in più notifiche. Ad esempio, lo stesso messaggio indipendente dalla piattaforma per l'hub di notifica può essere convertito senza problemi in un avviso di tipo avviso popup e in un aggiornamento del riquadro, senza che il back-end ne sia a conoscenza. Alcune piattaforme (ad esempio, iOS) potrebbero comprimere più notifiche allo stesso dispositivo se vengono inviate entro un breve periodo di tempo.
Utilizzo di modelli per la personalizzazione
Un altro vantaggio derivante dall'utilizzo di modelli è la possibilità di utilizzare gli Hub di notifica per eseguire la personalizzazione delle notifiche per registrazione. Si consideri ad esempio un'app meteo che visualizza un riquadro con le condizioni meteo in una posizione specifica. Un utente può scegliere tra gradi Celsius o Fahrenheit e una previsione singola o di cinque giorni. Mediante i modelli, ciascuna installazione dell'app client può registrare il formato richiesto (1 giorno in gradi Celsius 1 giorno in gradi Fahrenheit, 5 giorni in gradi Celsius, 5 giorni in gradi Fahrenheit), e far sì che il back-end invii un unico messaggio contenente tutte le informazioni necessarie per compilare i modelli (ad esempio una previsione di cinque giorni con gradi Celsius e Fahrenheit).
Il modello per la previsione di un giorno in gradi Celsius è il seguente:
<tile>
<visual>
<binding template="TileWideSmallImageAndText04">
<image id="1" src="$(day1_image)" alt="alt text"/>
<text id="1">Seattle, WA</text>
<text id="2">$(day1_tempC)</text>
</binding>
</visual>
</tile>
Il messaggio inviato all'hub di notifica contiene tutte le proprietà seguenti:
| day1_image | day2_image | day3_image | day4_image | day5_image |
|---|---|---|---|---|
| day1_tempC | day2_tempC | day3_tempC | day4_tempC | day5_tempC |
| day1_tempF | day2_tempF | day3_tempF | day4_tempF | day5_tempF |
Utilizzando questo modello, il back-end invia solo un unico messaggio senza dover memorizzare opzioni di personalizzazione specifiche per gli utenti dell'app. Questo scenario viene illustrato nell'immagine seguente:
Come registrare i modelli
Per eseguire la registrazione con i modelli usando il modello di installazione (preferito) o il modello di registrazione, vedere Gestione della registrazione.
Linguaggio di espressione dei modelli
I modelli sono limitati ai formati di documento XML o JSON. Inoltre, è possibile inserire solo espressioni in posizioni specifiche; Ad esempio, gli attributi o i valori del nodo per XML, i valori delle proprietà stringa per JSON.
Nella tabella seguente viene descritto il linguaggio consentito nei modelli:
| Expression | Descrizione |
|---|---|
| $(prop) | Riferimento a una proprietà di evento con il nome specificato. I nomi delle proprietà non distinguono tra maiuscole e minuscole. Questa espressione viene risolta nel valore di testo della proprietà o in una stringa vuota se la proprietà non è presente. |
| $(prop, n) | Come in precedenza, ma il testo viene esplicitamente troncato dopo n caratteri, ad esempio $(title, 20) tronca il contenuto della proprietà del riquadro dopo 20 caratteri. |
| .(prop, n) | Come in precedenza, ma vengono aggiunti tre punti alla fine del testo troncato. La dimensione totale della stringa ritagliata e il suffisso non supera n caratteri. (titolo, 20) con una proprietà di input "Questa è la riga del titolo" restituisce Questo è il titolo... |
| %(prop) | È simile a $(name), a eccezione del fatto che l'output è codificato in formato URI. |
| #(prop) | Utilizzata nei modelli JSON (ad esempio, per modelli iOS e Android). Questa funzione funziona esattamente come '$(prop)' specificata in precedenza, tranne quando viene usata nei modelli JSON (ad esempio, modelli Apple). In questo caso, se questa funzione non è racchiusa tra "{','}" (ad esempio, 'myJsonProperty': '#(name)') e restituisce un numero in formato JavaScript, ad esempio regexp: (0|( [1-9] [0-9]*))(.[ 0-9]+)? (e| E)(+|-)? [0-9]+)?, il codice JSON di output è un numero. Ad esempio, 'badge: '#(name)' diventa 'badge': 40 (e non '40'). |
| 'text' o "text" | Valore letterale. I valori letterali contengono testo arbitrario racchiuso tra virgolette singole o doppie. |
| expr1 + expr2 | Operatore di concatenazione che unisce due espressioni in una singola stringa. |
Il formato delle espressioni può essere uno dei precedenti.
Quando si usa la concatenazione, l'intera espressione deve essere racchiusa tra {}. Ad esempio, {$(prop) + ‘ - ’ + $(prop2)}.
Ad esempio, il modello XML seguente non è valido:
<tile>
<visual>
<binding $(property)>
<text id="1">Seattle, WA</text>
</binding>
</visual>
</tile>
Come spiegato in precedenza, quando si usa la concatenazione, le espressioni devono essere racchiuse tra parentesi graffe. Ad esempio:
<tile>
<visual>
<binding template="ToastText01">
<text id="1">{'Hi, ' + $(name)}</text>
</binding>
</visual>
</tile>