Listę metod dostępnych dla tego zasobu znajdziesz na końcu tej strony.
Reprezentacje zasobów
Każdy element na osi czasu użytkownika jest reprezentowany jako struktura JSON TimelineItem
, jak opisano poniżej.
{ "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 } }
Nazwa usługi | Wartość | Opis | Uwagi |
---|---|---|---|
attachments[] |
list |
Lista załączników multimedialnych powiązanych z tym elementem. Dla wygody możesz w odniesieniu do ładunków HTML odwoływać się do załączników lub schematu cid. Na przykład:
|
|
bundleId |
string |
Identyfikator pakietu elementu. Usługi mogą określać identyfikator pakietu, aby grupować wiele elementów. Wyświetlają się pod jednym elementem najwyższego poziomu na urządzeniu. | zapisywalny |
canonicalUrl |
string |
Kanoniczny URL wskazuje kanoniczną/wysoką wersję danych reprezentowanych przez element osi czasu. | zapisywalny |
created |
datetime |
Godzina utworzenia tego elementu podana w formacie RFC 3339. | |
creator |
nested object |
Użytkownik lub grupa, która utworzyła ten element. | zapisywalny |
displayTime |
datetime |
Czas wyświetlania tego elementu na osi czasu, zgodny z RFC 3339. Oś czasu tego użytkownika jest posortowana chronologicznie według czasu wyświetlania, więc określa też miejsce wyświetlania elementu na osi czasu. Jeśli nie ustawisz tej funkcji, jej czas wyświetlania jest domyślnie ustawiony na updated . |
zapisywalny |
etag |
etag |
ETag tego elementu. | |
html |
string |
Treść HTML tego elementu. Jeśli podany jest zarówno element text , jak i html , element html zostanie wyrenderowany na osi czasu. Dozwolone elementy HTML – możesz ich używać na kartach osi czasu.
Zablokowane elementy HTML: te elementy i ich zawartość są usuwane z ładunków HTML.
Inne elementy: wszystkie elementy, których nie ma na liście, są usuwane, ale ich zawartość zostaje zachowana. |
zapisywalny |
id |
string |
Identyfikator elementu na osi czasu. Jest unikalny w czasie użytkownika. | |
inReplyTo |
string |
Jeśli ten element został wygenerowany jako odpowiedź na inny element, w tym polu zostanie ustawiony identyfikator elementu, na który udzielono odpowiedzi. Możesz go użyć do dołączenia odpowiedzi do odpowiedniego wątku lub posta. | |
isBundleCover |
boolean |
Określa, czy ten element jest zdjęciem pakietu. Jeśli element jest oznaczony jako okładka pakietu, będzie punktem wejścia do pakietu elementów, które mają tę samą wartość bundleId co ten element. Będzie ona widoczna tylko na głównej osi czasu – nie w otwartym pakiecie.Na głównej osi czasu wyświetlają się następujące elementy:
|
zapisywalny |
isDeleted |
boolean |
Jeśli ma wartość true (prawda), wskazuje, że ten element został usunięty, a ustawiona jest tylko właściwość ID. | |
isPinned |
boolean |
Jeśli ma wartość true (prawda), wskazuje, że ten element jest przypięty, co oznacza, że jest grupowany obok elementów aktywnych, takich jak nawigacja i spotkania, po przeciwnej stronie ekranu głównego niż elementy historyczne (bez przypięcia). Możesz zezwolić użytkownikowi na przełączanie wartości tej właściwości za pomocą wbudowanego elementu menu TOGGLE_PINNED . |
|
kind |
string |
Typ zasobu. To jest zawsze mirror#timelineItem . |
|
location |
nested object |
Lokalizacja geograficzna powiązana z tym elementem. | zapisywalny |
menuItems[] |
list |
Lista pozycji menu, które będą wyświetlane użytkownikowi po wybraniu tego elementu na osi czasu. | zapisywalny |
menuItems[].action |
string |
Kontroluje zachowanie, gdy użytkownik wybiera opcję menu. Dozwolone wartości to:
|
zapisywalny |
menuItems[].id |
string |
Identyfikator tego elementu menu. Jest on generowany przez aplikację i jest traktowany jako nieprzejrzysty token. | zapisywalny |
menuItems[].payload |
string |
Ładunek ogólny, którego znaczenie zmienia się w zależności od działania tego elementu MenuItem.
|
zapisywalny |
menuItems[].removeWhenSelected |
boolean |
Jeśli w przypadku elementu menu CUSTOM ustawiono wartość „prawda”, po wybraniu zostanie on usunięty z menu. |
zapisywalny |
menuItems[].values[] |
list |
W przypadku elementów CUSTOM lista wartości określających wygląd elementu menu w każdym stanie. Musisz podać wartość stanu DEFAULT . Jeśli brakuje stanów PENDING lub CONFIRMED , nie będą one wyświetlane. |
zapisywalny |
menuItems[].values[].displayName |
string |
Nazwa wyświetlana w menu. Jeśli określisz tę właściwość w przypadku wbudowanego elementu menu, domyślne kontekstowe polecenie głosowe nie będzie wyświetlane. | zapisywalny |
menuItems[].values[].iconUrl |
string |
Adres URL ikony wyświetlanej w menu. | zapisywalny |
menuItems[].values[].state |
string |
Stan, którego dotyczy ta wartość. Dozwolone wartości to:
|
zapisywalny |
notification |
nested object |
Określa sposób wyświetlania powiadomień dotyczących danego elementu na urządzeniu. Jeśli go zabraknie, nie zostanie wygenerowane żadne powiadomienie. | zapisywalny |
notification.deliveryTime |
datetime |
Godzina doręczenia powiadomienia. | zapisywalny |
notification.level |
string |
Określa, jak ważne jest powiadomienie. Dozwolone wartości to:
|
zapisywalny |
pinScore |
integer |
W przypadku przypiętych elementów określa kolejność wyświetlania elementu na osi czasu, a wyższy wynik pojawia się bliżej zegara. Uwaga: ustawienie tego pola nie jest obecnie obsługiwane. | |
recipients[] |
list |
Lista użytkowników lub grup, którym udostępniono ten element. | zapisywalny |
selfLink |
string |
Adres URL, którego można użyć do pobrania tego elementu. | |
sourceItemId |
string |
Nieprzezroczysty ciąg znaków, którego możesz użyć do mapowania elementu osi czasu na dane w Twojej usłudze. | zapisywalny |
speakableText |
string |
Wersja głosu tego elementu. W połączeniu z pozycją w menu READ_ALOUD użyj tego pola, aby tekst był wyraźniejszy, gdy jest odczytywany na głos, albo podaj więcej informacji o tym, co jest wyświetlane w Google Glass.Oprogramowanie Glassware powinno też zawierać poleSpeakableType, które będzie wypowiadane przed tym tekstem, w sytuacjach, gdy dodatkowy kontekst będzie przydatny, na przykład gdy użytkownik poprosi, że element zostanie odczytany na głos po powiadomieniu. |
zapisywalny |
speakableType |
string |
Wyraźny opis typu tego elementu. O tym poinformujemy użytkownika przed przeczytaniem treści elementu, w sytuacji, gdy dodatkowy kontekst jest przydatny, na przykład gdy użytkownik zażąda, aby element został odczytany na głos po powiadomieniu. To powinno być krótkie, proste wyrażenie rzeczowe, np. „E-mail”, „SMS” lub „Codzienne aktualności dotyczące planet”. Zachęcamy do wypełniania tego pola w przypadku każdego elementu na osi czasu, nawet jeśli ten element nie zawiera tekstu lub tekstu możliwego do odczytania, aby użytkownik mógł poznać typ elementu bez patrzenia na ekran. |
zapisywalny |
text |
string |
Treść tego elementu. | zapisywalny |
title |
string |
Tytuł tego elementu. | zapisywalny |
updated |
datetime |
Moment ostatniej modyfikacji tego elementu, zgodnie z definicją RFC 3339. |
Metody
- usuń
- Usuwa element osi czasu.
- pobierz
- Pobiera pojedynczy element osi czasu według identyfikatora.
- wstaw
- Wstawia nowy element na osi czasu.
- list
- Pobiera listę osi czasu dla uwierzytelnionego użytkownika.
- poprawka
- Aktualizuje element na osi czasu. Ta metoda obsługuje semantykę poprawki.
- zaktualizuj
- Aktualizuje element na osi czasu.