Список методов для этого ресурса см. в конце этой страницы.
Представления ресурсов
Каждый элемент на временной шкале пользователя представлен в виде JSON-структуры TimelineItem
, описанной ниже.
{ "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 } }
Имя свойства | Ценить | Описание | Примечания |
---|---|---|---|
attachments[] | list | Список медиа-вложений, связанных с этим элементом. Для удобства вы можете ссылаться на вложения в полезных данных HTML с помощью схемы Attachment или cid. Например:
| |
bundleId | string | Идентификатор пакета для этого элемента. Службы могут указывать BundleId для группировки множества элементов вместе. Они отображаются под одним элементом верхнего уровня на устройстве. | записываемый |
canonicalUrl | string | Канонический URL-адрес, указывающий на каноническую/высококачественную версию данных, представленных элементом временной шкалы. | записываемый |
created | datetime | Время создания этого элемента, отформатированное в соответствии с RFC 3339. | |
creator | nested object | Пользователь или группа, создавшая этот элемент. | записываемый |
displayTime | datetime | Время, которое должно отображаться при просмотре этого элемента на временной шкале, отформатированное в соответствии с RFC 3339. Временная шкала этого пользователя сортируется в хронологическом порядке по времени отображения, поэтому это также будет определять, где элемент отображается на временной шкале. Если это не установлено службой, по умолчанию отображается updated время. | записываемый |
etag | etag | ETag для этого элемента. | |
html | string | HTML-содержимое этого элемента. Если для элемента указаны и text , и html , html будет отображаться на временной шкале.Разрешенные элементы HTML . Вы можете использовать эти элементы в своих карточках временной шкалы.
Заблокированные элементы HTML . Эти элементы и их содержимое удаляются из полезных данных HTML.
Другие элементы : все элементы, не указанные в списке, удаляются, но их содержимое сохраняется. | записываемый |
id | string | Идентификатор элемента временной шкалы. Это уникально в рамках временной шкалы пользователя. | |
inReplyTo | string | Если этот элемент был создан как ответ на другой элемент, в этом поле будет установлен идентификатор элемента, на который отвечаете. Это можно использовать, чтобы прикрепить ответ к соответствующему разговору или сообщению. | |
isBundleCover | boolean | Является ли этот товар чехлом для комплекта. Если элемент помечен как обложка пакета, он будет точкой входа в набор элементов, имеющих тот же bundleId , что и этот элемент. Он будет отображаться только на основной временной шкале, а не в открытом пакете .На основной временной шкале отображаются следующие элементы:
| записываемый |
isDeleted | boolean | Если это значение равно true, это означает, что этот элемент удален и установлено только свойство ID. | |
isPinned | boolean | Если это значение равно true, это означает, что этот элемент закреплен, что означает, что он сгруппирован вместе с «активными» элементами, такими как навигация и Hangouts, на противоположной стороне главного экрана от исторических (незакрепленных) элементов временной шкалы. Вы можете разрешить пользователю переключать значение этого свойства с помощью встроенного пункта меню TOGGLE_PINNED . | |
kind | string | Тип ресурса. Это всегда mirror#timelineItem . | |
location | nested object | Географическое местоположение, связанное с этим элементом. | записываемый |
menuItems[] | list | Список пунктов меню, который будет представлен пользователю при выборе этого пункта на временной шкале. | записываемый |
menuItems[]. action | string | Управляет поведением, когда пользователь выбирает пункт меню. Допустимые значения:
| записываемый |
menuItems[]. id | string | Идентификатор этого пункта меню. Он генерируется приложением и рассматривается как непрозрачный токен. | записываемый |
menuItems[]. payload | string | Общая полезная нагрузка, значение которой меняется в зависимости от действия этого MenuItem.
| записываемый |
menuItems[]. removeWhenSelected | boolean | Если для элемента меню CUSTOM установлено значение true, этот элемент будет удален из меню после его выбора. | записываемый |
menuItems[]. values[] | list | Для CUSTOM элементов — список значений, управляющих внешним видом пункта меню в каждом из его состояний. Необходимо указать значение для состояния DEFAULT . Если состояния PENDING или CONFIRMED отсутствуют, они не будут отображаться. | записываемый |
menuItems[].values[]. displayName | string | Имя, отображаемое для пункта меню. Если вы укажете это свойство для встроенного пункта меню, контекстная голосовая команда по умолчанию для этого пункта меню не отображается. | записываемый |
menuItems[].values[]. iconUrl | string | URL-адрес значка, который будет отображаться вместе с пунктом меню. | записываемый |
menuItems[].values[]. state | string | Состояние, к которому применяется это значение. Допустимые значения:
| записываемый |
notification | nested object | Управляет отображением уведомлений об этом элементе на устройстве. Если это отсутствует, уведомление не будет создано. | записываемый |
notification. deliveryTime | datetime | Время, в которое должно быть доставлено уведомление. | записываемый |
notification. level | string | Описывает, насколько важно уведомление. Допустимые значения:
| записываемый |
pinScore | integer | Для закрепленных элементов это определяет порядок, в котором элемент отображается на временной шкале, при этом более высокий балл отображается ближе к часам. Примечание. Установка этого поля в настоящее время не поддерживается. | |
recipients[] | list | Список пользователей или групп, которым был предоставлен доступ к этому элементу. | записываемый |
selfLink | string | URL-адрес, который можно использовать для получения этого элемента. | |
sourceItemId | string | Непрозрачная строка, которую можно использовать для сопоставления элемента временной шкалы с данными в вашем собственном сервисе. | записываемый |
speakableText | string | Озвученная версия содержания этого элемента. Наряду с элементом меню READ_ALOUD используйте это поле для ввода текста, который будет более четким при чтении вслух, или для предоставления расширенной информации к тому, что отображается визуально на Glass.Glassware также должен указать поле «speakableType», которое будет произноситься перед этим текстом в тех случаях, когда дополнительный контекст полезен, например, когда пользователь запрашивает чтение элемента вслух после уведомления. | записываемый |
speakableType | string | Разговорное описание типа этого предмета. Об этом будет объявлено пользователю до прочтения содержимого элемента в тех случаях, когда дополнительный контекст полезен, например, когда пользователь запрашивает чтение элемента вслух после уведомления. Это должна быть короткая простая существительная фраза, например «Электронная почта», «Текстовое сообщение» или «Обновление новостей Daily Planet». Glassware рекомендуется заполнять это поле для каждого элемента временной шкалы, даже если элемент не содержит говорящего текста или текста, чтобы пользователь мог узнать тип элемента, не глядя на экран. | записываемый |
text | string | Текстовое содержимое этого элемента. | записываемый |
title | string | Название этого элемента. | записываемый |
updated | datetime | Время последнего изменения этого элемента, отформатированное в соответствии с RFC 3339. |
Методы
- удалить
- Удаляет элемент временной шкалы.
- получать
- Получает один элемент временной шкалы по идентификатору.
- вставлять
- Вставляет новый элемент на временную шкалу.
- список
- Получает список элементов временной шкалы для аутентифицированного пользователя.
- пластырь
- Обновляет элемент временной шкалы на месте. Этот метод поддерживает семантику исправлений .
- обновлять
- Обновляет элемент временной шкалы на месте.