Consulta l'elenco dei metodi per questa risorsa alla fine di questa pagina.
Rappresentazioni delle risorse
Ogni elemento nella 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 degli allegati multimediali associati all'elemento. Per comodità, puoi fare riferimento agli allegati nei payload HTML con lo schema degli allegati o degli ID cliente. Ad esempio:
|
|
bundleId |
string |
L'ID bundle di questo articolo. I servizi possono specificare un bundleId per raggruppare molti elementi. Vengono visualizzati in corrispondenza di un singolo elemento di primo livello del dispositivo. | scrivibile |
canonicalUrl |
string |
Un URL canonico che rimanda alla versione canonica/di alta qualità dei dati rappresentati dall'elemento della sequenza temporale. | scrivibile |
created |
datetime |
L'ora in cui questo elemento è stato creato, formattato in base alla specifica RFC 3339. | |
creator |
nested object |
L'utente o il gruppo che ha creato questo elemento. | scrivibile |
displayTime |
datetime |
L'ora da visualizzare quando questo elemento viene visualizzato nella sequenza temporale, formattato in base alla specifica RFC 3339. La sequenza temporale di questo utente è ordinata in ordine cronologico sul momento della visualizzazione, quindi determinerà anche dove viene visualizzato l'elemento nella sequenza temporale. Se non viene impostato dal servizio, il valore predefinito è updated . |
scrivibile |
etag |
etag |
ETag per questo elemento. | |
html |
string |
Contenuti HTML per questo elemento. Se per un elemento vengono specificati sia text sia html , html viene visualizzato nella sequenza temporale. 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 presenti nell'elenco vengono rimossi, ma i loro contenuti vengono conservati. |
scrivibile |
id |
string |
L'ID della voce della sequenza temporale. È 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 vuoi rispondere. Questa opzione può essere utilizzata per allegare una risposta alla conversazione o al post appropriato. | |
isBundleCover |
boolean |
Se questo articolo fa parte di una copertina. Se un articolo è contrassegnato come pacchetto, sarà il punto di accesso al pacchetto di elementi che hanno lo stesso bundleId di quell'articolo. Verrà mostrato solo nella sequenza temporale principale, non all'interno del pacchetto aperto.Nella sequenza temporale principale gli elementi mostrati sono:
|
scrivibile |
isDeleted |
boolean |
Se true, indica che l'elemento è stato eliminato e solo la proprietà ID è impostata. | |
isPinned |
boolean |
Se true, indica che questo elemento è bloccato, il che significa che viene raggruppato insieme ad elementi "attivi", come la navigazione e gli Hangout, sul lato opposto della schermata Home rispetto agli elementi storici della cronologia (non bloccati). Puoi consentire all'utente di attivare o disattivare il valore di questa proprietà con la voce di menu integrata di TOGGLE_PINNED . |
|
kind |
string |
Il tipo di risorsa. È sempre mirror#timelineItem . |
|
location |
nested object |
La posizione geografica associata a questo elemento. | scrivibile |
menuItems[] |
list |
Un elenco di voci del menu che verranno presentate all'utente quando viene selezionato nella sequenza temporale. | scrivibile |
menuItems[].action |
string |
Consente di controllare il comportamento quando l'utente seleziona l'opzione di menu. I valori consentiti sono:
|
scrivibile |
menuItems[].id |
string |
L'ID di questa voce di menu. Viene generato dall'applicazione e considerato come un token opaco. | scrivibile |
menuItems[].payload |
string |
Un payload generico il cui significato cambia a seconda dell'azione di questo elemento del menu.
|
scrivibile |
menuItems[].removeWhenSelected |
boolean |
Se viene impostato su true in una voce di menu di CUSTOM , quest'ultima viene rimossa dal menu dopo essere selezionata. |
scrivibile |
menuItems[].values[] |
list |
Per le voci CUSTOM , un elenco di valori che controllano l'aspetto della voce di menu in ciascuno dei relativi stati. È necessario fornire un valore per lo stato DEFAULT . Gli stati PENDING o CONFIRMED mancanti non verranno mostrati. |
scrivibile |
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 tale voce di menu non viene visualizzato. | scrivibile |
menuItems[].values[].iconUrl |
string |
URL di un'icona da visualizzare con la voce di menu. | scrivibile |
menuItems[].values[].state |
string |
Lo stato a cui si applica questo valore. I valori consentiti sono:
|
scrivibile |
notification |
nested object |
Controlla la modalità di presentazione sul dispositivo delle notifiche relative a questo elemento. Se non è presente, non verrà generata alcuna notifica. | scrivibile |
notification.deliveryTime |
datetime |
L'ora in cui dovrebbe essere consegnata la notifica. | scrivibile |
notification.level |
string |
Descrive l'importanza della notifica. I valori consentiti sono:
|
scrivibile |
pinScore |
integer |
Per gli elementi in primo piano, determina l'ordine di visualizzazione dell'elemento nella sequenza temporale, con un punteggio più alto visualizzato più vicino all'orologio. Nota: al momento, l'impostazione di questo campo non è supportata. | |
recipients[] |
list |
Un elenco di utenti o gruppi con cui è stato condiviso questo elemento. | scrivibile |
selfLink |
string |
Un URL che può essere utilizzato per recuperare questo elemento. | |
sourceItemId |
string |
Stringa poco chiara che puoi utilizzare per mappare un elemento della sequenza temporale ai dati del tuo servizio. | scrivibile |
speakableText |
string |
La versione pronunciabile dei contenuti di questo elemento. Insieme alla voce di menu READ_ALOUD , utilizza questo campo per fornire un testo più chiaro se lette ad alta voce o per informazioni estese su ciò che viene visualizzato visivamente su Glass.Inoltre, è necessario specificare il campo speakableType, che verrà letto prima di questo testo nei casi in cui il contesto aggiuntivo è utile, ad esempio quando l'utente richiede che l'elemento venga letto ad alta voce in seguito a una notifica. |
scrivibile |
speakableType |
string |
Una descrizione pronunciabile del tipo di questo elemento. Questa comunicazione verrà annunciata 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 in seguito a una notifica. Deve essere una frase nome semplice e breve, come "Email", "SMS" o "Aggiornamento giornalista del pianeta". Ti invitiamo a compilare questo campo 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. |
scrivibile |
text |
string |
Contenuti testuali di questo elemento. | scrivibile |
title |
string |
Il titolo dell'articolo. | scrivibile |
updated |
datetime |
L'ora dell'ultima modifica dell'elemento, formattata secondo la specifica RFC 3339. |
Metodi
- elimina
- Elimina una voce della sequenza temporale.
- ricevi
- Ricevi un singolo elemento della sequenza temporale in base all'ID.
- inserire
- Inserisce un nuovo elemento nella sequenza temporale.
- list
- Recupera un elenco di elementi della sequenza temporale per l'utente autenticato.
- patch
- Aggiorna un elemento della sequenza temporale. Questo metodo supporta la semantica delle patch.
- Aggiorna
- Aggiorna un elemento della sequenza temporale.