Para ver uma lista de métodos desse recurso, consulte o final desta página.
Representações de recursos
Cada item na linha do tempo do usuário é representado como uma estrutura JSON TimelineItem
, descrita abaixo.
{ "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 da propriedade | Valor | Descrição | Observações |
---|---|---|---|
attachments[] |
list |
Uma lista de anexos de mídia associados a este item. Por conveniência, você pode fazer referência aos anexos nos seus payloads HTML com o anexo ou esquema cid. Por exemplo:
|
|
bundleId |
string |
O ID do pacote deste item. Os serviços podem especificar um bundleId para agrupar vários itens. Eles aparecem em um único item de nível superior no dispositivo. | gravável |
canonicalUrl |
string |
Um URL canônico que aponta para a versão canônica/de alta qualidade dos dados representados pelo item da linha do tempo. | gravável |
created |
datetime |
A hora em que este item foi criado, formatado de acordo com o RFC 3339. | |
creator |
nested object |
O usuário ou grupo que criou o item. | gravável |
displayTime |
datetime |
É o horário que deve ser exibido quando o item é visualizado na linha do tempo, formatado de acordo com o RFC 3339. A linha do tempo desse usuário é organizada de acordo com o tempo de exibição, o que também determina onde o item aparece. Se não for definido pelo serviço, o tempo de exibição será definido como updated por padrão. |
gravável |
etag |
etag |
a ETag deste item. | |
html |
string |
Conteúdo HTML deste item. Se text e html forem fornecidos para um item, o html será renderizado no cronograma. Elementos HTML permitidos: você pode usar esses elementos nos cards da linha do tempo.
Elementos HTML bloqueados: esses elementos e o conteúdo deles são removidos dos payloads HTML.
Outros elementos: todos os elementos não listados serão removidos, mas o conteúdo deles será preservado. |
gravável |
id |
string |
ID do item da linha do tempo. Ele é exclusivo na linha do tempo de um usuário. | |
inReplyTo |
string |
Se este item foi gerado como uma resposta a outro item, esse campo será definido como o ID do item que está sendo respondido. Ele pode ser usado para anexar uma resposta à conversa ou postagem apropriada. | |
isBundleCover |
boolean |
Indica se este item é uma capa de pacote. Se um item for marcado como uma capa de pacote, ele será o ponto de entrada para o pacote de itens que tenham o mesmo bundleId . Ele será exibido somente na linha do tempo principal, não no pacote aberto.Na linha do tempo principal, os itens mostrados são:
|
gravável |
isDeleted |
boolean |
Quando verdadeiro, indica que o item foi excluído e apenas a propriedade ID foi definida. | |
isPinned |
boolean |
Quando verdadeiro, indica que o item está fixado, o que significa que está agrupado ao lado de "ativo" itens como navegação e Hangouts, no lado oposto da tela inicial, dos itens da linha do tempo históricos (não fixados). Você pode permitir que o usuário alterne o valor dessa propriedade com o item de menu integrado TOGGLE_PINNED . |
|
kind |
string |
O tipo de recurso. É sempre mirror#timelineItem . |
|
location |
nested object |
A localização geográfica associada a este item. | gravável |
menuItems[] |
list |
Uma lista de itens de menu que vão ser apresentados ao usuário quando esse item for selecionado na linha do tempo. | gravável |
menuItems[].action |
string |
Controla o comportamento quando o usuário escolhe a opção do menu. Os valores permitidos são:
|
gravável |
menuItems[].id |
string |
O ID desse item de menu. Ele é gerado pelo aplicativo e tratado como um token opaco. | gravável |
menuItems[].payload |
string |
Um payload genérico cujo significado muda dependendo da ação desse MenuItem.
|
gravável |
menuItems[].removeWhenSelected |
boolean |
Se definido como verdadeiro em um item de menu do CUSTOM , ele será removido do menu depois de ser selecionado. |
gravável |
menuItems[].values[] |
list |
Para itens CUSTOM , uma lista de valores que controlam a aparência do item de menu em cada um dos estados. É necessário fornecer um valor para o estado DEFAULT . Se os estados PENDING ou CONFIRMED estiverem ausentes, eles não serão exibidos. |
gravável |
menuItems[].values[].displayName |
string |
Nome a ser exibido para o item de menu. Se você especificar essa propriedade para um item de menu integrado, o comando de voz contextual padrão desse item de menu não será mostrado. | gravável |
menuItems[].values[].iconUrl |
string |
URL de um ícone a ser exibido com o item de menu. | gravável |
menuItems[].values[].state |
string |
O estado ao qual este valor se aplica. Os valores permitidos são:
|
gravável |
notification |
nested object |
Controla como as notificações deste item são apresentadas no dispositivo. Se essa informação não for informada, nenhuma notificação será gerada. | gravável |
notification.deliveryTime |
datetime |
O horário em que a notificação deve ser entregue. | gravável |
notification.level |
string |
Descreve a importância da notificação. Os valores permitidos são:
|
gravável |
pinScore |
integer |
Para itens fixados, determina a ordem em que o item é exibido na linha do tempo, com a pontuação mais alta aparecendo mais perto do relógio. Observação: no momento, não é possível configurar esse campo. | |
recipients[] |
list |
Uma lista de usuários ou grupos com os quais este item foi compartilhado. | gravável |
selfLink |
string |
Um URL que pode ser usado para recuperar este item. | |
sourceItemId |
string |
String opaca que você pode usar para mapear um item da linha do tempo para dados no seu próprio serviço. | gravável |
speakableText |
string |
A versão falada do conteúdo deste item. Além do item de menu READ_ALOUD , use esse campo para fornecer um texto mais claro quando lido em voz alta ou para fornecer mais informações sobre o que é exibido visualmente no Google Glass.O Glassware também precisa especificar o campo SpeakableType, que será falado antes do texto quando o contexto adicional for útil, por exemplo, quando o usuário solicitar que o item seja lido em voz alta após uma notificação. |
gravável |
speakableType |
string |
Uma descrição falada do tipo deste item. Isso será anunciado ao usuário antes da leitura do conteúdo do item nos casos em que o contexto adicional for útil, por exemplo, quando o usuário solicitar que o item seja lido em voz alta após uma notificação. Deve ser um sintagma nominal curto e simples, como "E-mail", "Mensagem de texto" ou "Atualização diária de novidades do planeta". Os Glasswares são incentivados a preencher esse campo para cada item da linha do tempo, mesmo que o item não contenha speakableText ou texto, para que o usuário possa aprender o tipo do item sem olhar para a tela. |
gravável |
text |
string |
Conteúdo de texto deste item. | gravável |
title |
string |
Título deste item. | gravável |
updated |
datetime |
A hora em que este item foi modificado pela última vez, formatado de acordo com o RFC 3339. |
Métodos
- delete
- Exclui um item da linha do tempo.
- get
- Recebe um único item da linha do tempo por ID.
- inserir
- Insere um novo item na linha do tempo.
- list
- Recupera uma lista de itens da linha do tempo do usuário autenticado.
- patch
- Atualiza um item da linha do tempo em vigor. Esse método é compatível com a semântica de patch.
- update
- Atualiza um item da linha do tempo em vigor.