La liste des méthodes associées à cette ressource est présentée au bas de la page.
Représentations de la ressource
Chaque élément de la chronologie de l'utilisateur est représenté par une structure JSON TimelineItem
, décrite ci-dessous.
{ "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 } }
Nom de propriété | Valeur | Description | Remarques |
---|---|---|---|
attachments[] |
list |
Liste des pièces jointes multimédias associées à cet élément. Pour plus de commodité, vous pouvez faire référence aux pièces jointes de vos charges utiles HTML avec le schéma de pièce jointe ou cid. Exemple:
|
|
bundleId |
string |
ID du bundle de cet article. Les services peuvent spécifier un bundleId pour regrouper plusieurs éléments. Elles apparaissent sous un seul élément de premier niveau sur l'appareil. | accessible en écriture |
canonicalUrl |
string |
URL canonique pointant vers la version canonique/de haute qualité des données représentées par l'élément de la timeline. | accessible en écriture |
created |
datetime |
Date et heure de création de l'élément, dans un format conforme à la norme RFC 3339. | |
creator |
nested object |
Utilisateur ou groupe qui a créé cet élément. | accessible en écriture |
displayTime |
datetime |
Heure à afficher lors de l'affichage de cet élément dans la chronologie, au format conforme à la norme RFC 3339. La chronologie de cet utilisateur est triée chronologiquement en fonction de l'heure d'affichage. Cela détermine donc l'endroit où l'élément est affiché dans la chronologie. Si elle n'est pas définie par le service, elle est définie par défaut sur updated . |
accessible en écriture |
etag |
etag |
ETag pour cet élément. | |
html |
string |
Contenu HTML pour cet élément. Si text et html sont fournis pour un élément, html est affiché dans la timeline. Éléments HTML autorisés : vous pouvez utiliser ces éléments dans vos fiches chronologiques.
Éléments HTML bloqués: ces éléments et leur contenu sont supprimés des charges utiles HTML.
Autres éléments: tous les éléments non listés sont supprimés, mais leur contenu est conservé. |
accessible en écriture |
id |
string |
ID de l'élément de la chronologie. Il est unique dans la chronologie d'un utilisateur. | |
inReplyTo |
string |
Si cet élément a été généré en réponse à un autre élément, ce champ sera défini sur l'identifiant de l'élément auquel la réponse a été envoyée. Vous pouvez ainsi joindre une réponse à la conversation ou au post correspondants. | |
isBundleCover |
boolean |
Indique s'il s'agit d'une couverture d'offre groupée. Si un article est marqué comme couverture pour un lot, il s'agit du point d'entrée du lot qui possède le même bundleId que cet article. Il ne s'affichera que dans la timeline principale, et non dans le bundle ouvert.Dans la chronologie principale, les éléments affichés sont les suivants:
|
accessible en écriture |
isDeleted |
boolean |
Si la valeur est "true", cela signifie que cet élément est supprimé et que seule la propriété "ID" est définie. | |
isPinned |
boolean |
Si la valeur est "true", indique que cet élément est épinglé, ce qui signifie qu'il est regroupé avec "actif". des éléments tels que la navigation et les Hangouts, de l'autre côté de l'écran d'accueil des éléments de la chronologie historiques (non épinglés). Vous pouvez autoriser l'utilisateur à activer/désactiver la valeur de cette propriété à l'aide de l'élément de menu intégré TOGGLE_PINNED . |
|
kind |
string |
Type de ressource. Il s'agit toujours de mirror#timelineItem . |
|
location |
nested object |
Zone géographique associée à cet élément. | accessible en écriture |
menuItems[] |
list |
Liste des éléments de menu qui sont présentés à l'utilisateur lorsque cet élément est sélectionné dans la chronologie. | accessible en écriture |
menuItems[].action |
string |
Contrôle le comportement lorsque l'utilisateur sélectionne l'option de menu. Valeurs autorisées:
|
accessible en écriture |
menuItems[].id |
string |
ID de cet élément de menu. Il est généré par l'application et traité comme un jeton opaque. | accessible en écriture |
menuItems[].payload |
string |
Charge utile générique dont la signification change en fonction de l'action de cet élément MenuItem.
|
accessible en écriture |
menuItems[].removeWhenSelected |
boolean |
Si elle est définie sur "true" sur un élément de menu CUSTOM , cet élément sera supprimé du menu une fois sélectionné. |
accessible en écriture |
menuItems[].values[] |
list |
Pour les éléments CUSTOM , liste de valeurs contrôlant l'apparence de l'élément de menu dans chacun de ses états. Une valeur doit être fournie pour l'état DEFAULT . Si les états PENDING ou CONFIRMED sont manquants, ils ne seront pas affichés. |
accessible en écriture |
menuItems[].values[].displayName |
string |
Nom à afficher pour l'élément de menu. Si vous spécifiez cette propriété pour un élément de menu intégré, la commande vocale contextuelle par défaut de cet élément de menu ne s'affiche pas. | accessible en écriture |
menuItems[].values[].iconUrl |
string |
URL d'une icône à afficher avec l'élément de menu. | accessible en écriture |
menuItems[].values[].state |
string |
État auquel cette valeur s'applique. Valeurs autorisées:
|
accessible en écriture |
notification |
nested object |
Contrôle la façon dont les notifications pour cet élément sont présentées sur l'appareil. Si ce champ n'est pas renseigné, aucune notification ne sera générée. | accessible en écriture |
notification.deliveryTime |
datetime |
Heure à laquelle la notification doit être envoyée. | accessible en écriture |
notification.level |
string |
Décrit l'importance de la notification. Valeurs autorisées:
|
accessible en écriture |
pinScore |
integer |
Pour les éléments épinglés, cette option détermine l'ordre dans lequel ils s'affichent dans la chronologie. Un score plus élevé apparaît plus près de l'horloge. Remarque: Il n'est actuellement pas possible de définir ce champ. | |
recipients[] |
list |
Liste des utilisateurs ou des groupes avec lesquels cet élément a été partagé. | accessible en écriture |
selfLink |
string |
URL permettant de récupérer cet élément. | |
sourceItemId |
string |
Chaîne opaque que vous pouvez utiliser pour mapper un élément de la chronologie avec les données de votre propre service. | accessible en écriture |
speakableText |
string |
Version prononçable du contenu de cet élément. En plus de l'élément de menu READ_ALOUD , utilisez ce champ pour fournir un texte plus clair à lire à voix haute ou pour fournir des informations détaillées sur ce qui s'affiche visuellement sur Glass.Glassware doit également spécifier le champ "SpeakableType", qui sera prononcé avant ce texte si le contexte supplémentaire est utile, par exemple lorsque l'utilisateur demande que l'élément soit lu à voix haute après une notification. |
accessible en écriture |
speakableType |
string |
Description prononçable du type de cet élément. Cette information est annoncée à l'utilisateur avant la lecture du contenu de l'élément si le contexte supplémentaire est utile, par exemple lorsqu'il demande à ce que l'élément soit lu à voix haute après une notification. Il doit s'agir d'un nom court et simple tel que "Email", "Text message" ou "Daily Planet News Update". Glassware est invité à renseigner ce champ pour chaque élément de la chronologie, même s'il ne contient pas de texte pouvant être énoncé ni de texte, afin que l'utilisateur puisse apprendre le type de l'élément sans regarder l'écran. |
accessible en écriture |
text |
string |
Contenu textuel de cet élément. | accessible en écriture |
title |
string |
Titre de cet élément. | accessible en écriture |
updated |
datetime |
Date et heure de la dernière modification de l'élément, dans un format conforme à la norme RFC 3339. |
Méthodes
- supprimer
- Supprime un élément de la chronologie.
- get
- Récupère un seul élément de la chronologie par ID.
- insérer
- Insère un nouvel élément dans la timeline.
- liste
- Récupère la liste des éléments de la chronologie pour l'utilisateur authentifié.
- patch
- Met à jour un élément de la chronologie. Cette méthode est compatible avec la sémantique "patch".
- mise à jour
- Met à jour un élément de la chronologie.