Per un elenco di metodi per questa risorsa, vai alla fine di questa pagina.
Rappresentazioni delle risorse
Ogni elemento della sequenza temporale dell'utente è rappresentato da una struttura JSON TimelineItem
, descritta di seguito.
{ "kind": "mirror#timelineItem", "id": string, "sourceItemId": string, "canonicalUrl": string, "bundleId": string, "isBundleCover": boolean, "selfLink": string, "created": datetime, "updated": datetime, "displayTime": datetime, "isPinned": boolean, "pinScore": integer, "isDeleted": boolean, "etag": etag, "creator": contacts Resource, "recipients": [ contacts Resource ], "inReplyTo": string, "title": string, "text": string, "html": string, "speakableType": string, "speakableText": string, "attachments": [ timeline.attachments Resource ], "location": locations Resource, "menuItems": [ { "id": string, "action": string, "values": [ { "state": string, "displayName": string, "iconUrl": string } ], "removeWhenSelected": boolean, "payload": string } ], "notification": { "level": string, "deliveryTime": datetime } }
Nome proprietà | Valore | Descrizione | Note |
---|---|---|---|
attachments[] |
list |
Un elenco di allegati multimediali associati a questo elemento. Per comodità, puoi fare riferimento agli allegati nei payload HTML con lo schema degli allegati o del cid. Ad esempio:
|
|
bundleId |
string |
L'ID pacchetto di questo articolo. I servizi possono specificare un bundleId per raggruppare molti elementi. Vengono visualizzati in un singolo elemento di primo livello sul dispositivo. | accessibile in scrittura |
canonicalUrl |
string |
Un URL canonico che rimanda alla versione canonica/di alta qualità dei dati rappresentati dall'elemento della sequenza temporale. | accessibile in scrittura |
created |
datetime |
L'ora in cui questo elemento è stato creato, formattato in base a RFC 3339. | |
creator |
nested object |
L'utente o il gruppo che ha creato questo elemento. | accessibile in scrittura |
displayTime |
datetime |
L'ora che dovrebbe essere visualizzata quando l'elemento viene visualizzato nella sequenza temporale, formattato in base a RFC 3339. La sequenza temporale di questo utente è ordinata cronologicamente in base al tempo di visualizzazione, in questo modo verrà stabilito anche dove viene visualizzato l'elemento nella sequenza temporale. Se non è impostato dal servizio, per impostazione predefinita il tempo di visualizzazione è updated . |
accessibile in scrittura |
etag |
etag |
ETag per questo elemento. | |
html |
string |
Contenuti HTML per questo elemento. Se per un elemento vengono forniti sia text sia html , nella sequenza temporale verrà visualizzato html . Elementi HTML consentiti: puoi utilizzare questi elementi nelle schede della sequenza temporale.
Elementi HTML bloccati: questi elementi e i relativi contenuti vengono rimossi dai payload HTML.
Altri elementi: tutti gli elementi non elencati vengono rimossi, ma i relativi contenuti vengono conservati. |
accessibile in scrittura |
id |
string |
L'ID dell'elemento della sequenza temporale. Si tratta di un valore univoco all'interno della sequenza temporale di un utente. | |
inReplyTo |
string |
Se questo elemento è stato generato come risposta a un altro elemento, questo campo verrà impostato sull'ID dell'elemento a cui si risponde. Può essere utilizzato per allegare una risposta alla conversazione o al post appropriato. | |
isBundleCover |
boolean |
Se l'articolo è una copertina in bundle. Se un elemento è contrassegnato come copertina in bundle, sarà il punto di accesso al gruppo di articoli che hanno gli stessi bundleId dell'articolo. Verrà mostrato solo sulla sequenza temporale principale, non all'interno del bundle aperto.Nella sequenza temporale principale, gli elementi visualizzati sono:
|
accessibile in scrittura |
isDeleted |
boolean |
Se impostato su true, indica che l'elemento è stato eliminato e che è impostata solo la proprietà ID. | |
isPinned |
boolean |
Se impostato su true, indica che l'elemento è bloccato, il che significa che è raggruppato accanto ad "attivo" elementi come navigazione e Hangout, sul lato opposto della schermata Home rispetto agli elementi storici (non fissati) della sequenza temporale. Puoi consentire all'utente di attivare/disattivare il valore di questa proprietà con la voce di menu integrata TOGGLE_PINNED . |
|
kind |
string |
Il tipo di risorsa. Il valore è sempre mirror#timelineItem . |
|
location |
nested object |
La posizione geografica associata a questo elemento. | accessibile in scrittura |
menuItems[] |
list |
Un elenco di voci di menu che verranno presentate all'utente quando questa voce viene selezionata nella sequenza temporale. | accessibile in scrittura |
menuItems[].action |
string |
Consente di controllare il comportamento quando l'utente seleziona l'opzione di menu. I valori consentiti sono:
|
accessibile in scrittura |
menuItems[].id |
string |
L'ID di questa voce di menu. Viene generato dall'applicazione e viene considerato come un token opaco. | accessibile in scrittura |
menuItems[].payload |
string |
Un payload generico il cui significato cambia in base all'azione di questo elemento di menu.
|
accessibile in scrittura |
menuItems[].removeWhenSelected |
boolean |
Se il criterio viene impostato su true per una voce di menu CUSTOM , dopo la selezione l'elemento in questione verrà rimosso dal menu. |
accessibile in scrittura |
menuItems[].values[] |
list |
Per le voci CUSTOM , un elenco di valori che controllano l'aspetto della voce di menu in ciascuno dei suoi stati. È necessario specificare un valore per lo stato DEFAULT . Se gli stati PENDING o CONFIRMED sono mancanti, non verranno visualizzati. |
accessibile in scrittura |
menuItems[].values[].displayName |
string |
Il nome da visualizzare per la voce di menu. Se specifichi questa proprietà per una voce di menu integrata, il comando vocale contestuale predefinito per quella voce di menu non viene visualizzato. | accessibile in scrittura |
menuItems[].values[].iconUrl |
string |
URL di un'icona da visualizzare con la voce di menu. | accessibile in scrittura |
menuItems[].values[].state |
string |
Lo stato a cui si applica questo valore. I valori consentiti sono:
|
accessibile in scrittura |
notification |
nested object |
Consente di controllare la modalità di presentazione sul dispositivo delle notifiche per questo elemento. Se manca, non verrà generata alcuna notifica. | accessibile in scrittura |
notification.deliveryTime |
datetime |
L'ora in cui deve essere inviata la notifica. | accessibile in scrittura |
notification.level |
string |
Descrive l'importanza della notifica. I valori consentiti sono:
|
accessibile in scrittura |
pinScore |
integer |
Per gli elementi bloccati, determina l'ordine in cui l'elemento viene visualizzato nella sequenza temporale, con un punteggio più alto visualizzato più vicino all'orologio. Nota: l'impostazione di questo campo non è attualmente supportata. | |
recipients[] |
list |
Un elenco di utenti o gruppi con cui è stato condiviso questo elemento. | accessibile in scrittura |
selfLink |
string |
Un URL che può essere utilizzato per recuperare questo elemento. | |
sourceItemId |
string |
Stringa opaca che puoi utilizzare per mappare un elemento della sequenza temporale ai dati del tuo servizio. | accessibile in scrittura |
speakableText |
string |
La versione pronunciabile dei contenuti di questo elemento. Insieme alla voce di menu READ_ALOUD , usa questo campo per fornire testo che sarebbe più chiaro se letto ad alta voce o per fornire informazioni estese su ciò che viene visualizzato visivamente su Glass.Glassware deve anche specificare il campo speakableType, che verrà pronunciato prima di questo testo nei casi in cui il contesto aggiuntivo sia utile, ad esempio quando l'utente richiede che l'elemento venga letto ad alta voce dopo una notifica. |
accessibile in scrittura |
speakableType |
string |
Una descrizione pronunciabile del tipo di questo elemento. Questo verrà annunciato all'utente prima di leggere i contenuti dell'elemento nei casi in cui il contesto aggiuntivo sia utile, ad esempio quando l'utente richiede che l'elemento venga letto ad alta voce dopo una notifica. Deve essere una frase nome breve e semplice, come "Email", "SMS" o "Aggiornamento giornaliero sul pianeta". Si consiglia di compilare questo campo per Glassware per ogni elemento della sequenza temporale, anche se l'elemento non contiene speakableText o testo, in modo che l'utente possa conoscere il tipo di elemento senza guardare lo schermo. |
accessibile in scrittura |
text |
string |
Contenuti testuali di questo elemento. | accessibile in scrittura |
title |
string |
Il titolo di questo elemento. | accessibile in scrittura |
updated |
datetime |
La data e l'ora in cui questo elemento è stato modificato per l'ultima volta, formattato in base a RFC 3339. |
Metodi
- elimina
- Elimina un elemento della cronologia.
- trova
- Recupera un singolo elemento della sequenza temporale in base all'ID.
- inserisci
- Inserisce un nuovo elemento nella sequenza temporale.
- list
- Recupera un elenco di elementi della cronologia per l'utente autenticato.
- patch
- Aggiorna un elemento della cronologia. Questo metodo supporta la semantica della patch.
- aggiorna
- Aggiorna un elemento della cronologia.