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 dans vos charges utiles HTML avec le rattachement ou le schéma cid. Exemple:
|
|
bundleId |
string |
ID du bundle pour cet article. Les services peuvent spécifier un bundleId pour regrouper de nombreux éléments. Ils apparaissent sous un seul élément de premier niveau sur l'appareil. | accessible en écriture |
canonicalUrl |
string |
URL canonique renvoyant 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, au format RFC 3339. | |
creator |
nested object |
Utilisateur ou groupe ayant créé cet élément. | accessible en écriture |
displayTime |
datetime |
Heure à afficher lorsque l'élément est consulté dans la timeline, au format RFC 3339. La chronologie de cet utilisateur est triée de façon chronologique en fonction de sa durée d'affichage. Il détermine donc également où l'élément doit s'afficher dans la chronologie. Si elle n'est pas définie par le service, l'heure d'affichage 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 les valeurs text et html sont fournies pour un élément, html s'affiche dans la timeline. Éléments HTML autorisés : vous pouvez utiliser ces éléments dans vos fiches de chronologie.
É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 qui ne sont pas listés sont supprimés, mais leur contenu est conservé. |
accessible en écriture |
id |
string |
ID de l'élément de la timeline. 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, ce champ est défini sur l'ID de l'élément auquel vous répondez. Vous pouvez utiliser cette option pour joindre une réponse à la conversation ou au post concerné. | |
isBundleCover |
boolean |
Indique si cet article est une couverture de lot. Si un article est marqué comme couverture du lot, il constitue le point d'entrée vers le lot d'éléments ayant le même bundleId que cet élément. Elle s'affichera uniquement sur la timeline principale, pas dans le groupe ouvert.Sur la chronologie principale, les éléments affichés sont les suivants :
|
accessible en écriture |
isDeleted |
boolean |
Lorsque la valeur est "true", cela indique que cet élément a été supprimé et que seule la propriété "ID" est définie. | |
isPinned |
boolean |
Lorsque la valeur est "true", cela indique que cet élément est épinglé, c'est-à-dire qu'il est regroupé avec des éléments "actifs" comme la navigation et les Hangouts, à l'opposé de l'historique des éléments de la chronologie (non épinglés). Vous pouvez autoriser l'utilisateur à activer/désactiver la valeur de cette propriété avec l'élément de menu intégré TOGGLE_PINNED . |
|
kind |
string |
Type de ressource. Il s'agit toujours de mirror#timelineItem . |
|
location |
nested object |
Emplacement géographique associé à cet élément. | accessible en écriture |
menuItems[] |
list |
Liste d'éléments de menu qui seront présentés à l'utilisateur lorsque cet élément sera 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 de menu.
|
accessible en écriture |
menuItems[].removeWhenSelected |
boolean |
Si la valeur est définie sur "true" pour un élément de menu CUSTOM , cet élément est supprimé du menu une fois sélectionné. |
accessible en écriture |
menuItems[].values[] |
list |
Pour CUSTOM éléments, liste de valeurs contrôlant l'apparence de l'élément de menu dans chacun de ses états. Vous devez fournir une valeur 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 n'apparaît 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 présentation des notifications pour cet élément sur l'appareil. Si ce n'est pas le cas, 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, cet ordre détermine l'ordre d'affichage des éléments dans la timeline. Un score plus élevé apparaît juste avant l'horloge. Remarque: La définition de ce champ n'est actuellement pas possible. | |
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 timeline avec les données de votre propre service. | accessible en écriture |
speakableText |
string |
Version énoncée du contenu de cet élément. À l'aide de l'élément de menu READ_ALOUD , utilisez ce champ pour fournir un texte plus clair pour la lecture à voix haute ou pour fournir des informations plus détaillées sur le contenu affiché sur Google Glass.Glassware doit également spécifier le champ "talkableType", qui sera lu avant ce texte lorsque 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 |
Une description vocale du type d'élément Cette information sera annoncée à l'utilisateur avant la lecture du contenu de l'élément 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. Il doit s'agir d'un nom court et simple tel que "E-mail", "SMS" ou "Actualité Planète quotidienne". Nous vous invitons à renseigner ce champ pour chaque élément de la chronologie, même si l'élément ne contient ni texte prononcé ni texte, afin que l'utilisateur puisse apprendre à identifier le type d'é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 article. | accessible en écriture |
updated |
datetime |
Date et heure de la dernière modification de cet élément, au format RFC 3339. |
Méthodes
- supprimer
- Supprime un élément de chronologie.
- obtenir
- Récupère un seul élément de chronologie par ID.
- insérer
- Insère un nouvel élément dans la timeline.
- list
- Récupère une liste d'éléments de chronologie pour l'utilisateur authentifié.
- correctif
- Met à jour un élément de chronologie. Cette méthode est compatible avec la sémantique "patch".
- mettre à jour
- Met à jour un élément de chronologie.