Список методов для этого ресурса см. в конце этой страницы.
Представления ресурсов
Каждый элемент на временной шкале пользователя представлен в виде структуры 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 с помощью схемы вложения или 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 указывает, что этот элемент закреплен, что означает, что он сгруппирован вместе с «активными» элементами, такими как навигация и видеовстречи, на противоположной стороне главного экрана от исторических (не закрепленных) элементов временной шкалы. Вы можете разрешить пользователю переключать значение этого свойства с помощью встроенного пункта меню TOGGLE_PINNED . | |
kind | string | Тип ресурса. Это всегда mirror#timelineItem . | |
location | nested object | Географическое положение, связанное с этим элементом. | доступный для записи |
menuItems[] | list | Список пунктов меню, которые будут представлены пользователю при выборе этого пункта на временной шкале. | доступный для записи |
menuItems[]. action | string | Управляет поведением, когда пользователь выбирает пункт меню. Допустимые значения:
| доступный для записи |
menuItems[]. id | string | Идентификатор этого пункта меню. Он генерируется приложением и рассматривается как непрозрачный токен. | доступный для записи |
menuItems[]. payload | string | Общая полезная нагрузка, значение которой меняется в зависимости от действия этого элемента меню.
| доступный для записи |
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 | Произносимое описание типа этого предмета. Это будет объявлено пользователю перед чтением содержимого элемента в случаях, когда дополнительный контекст полезен, например, когда пользователь запрашивает чтение элемента вслух после уведомления. Это должна быть короткая простая именная фраза, такая как «Электронная почта», «Текстовое сообщение» или «Ежедневное обновление новостей планеты». Glassware рекомендуется заполнять это поле для каждого элемента временной шкалы, даже если элемент не содержит speakableText или текста, чтобы пользователь мог узнать тип элемента, не глядя на экран. | доступный для записи |
text | string | Текстовое содержимое этого элемента. | доступный для записи |
title | string | Название этого элемента. | доступный для записи |
updated | datetime | Время последнего изменения этого элемента, отформатированное в соответствии с RFC 3339. |
Методы
- удалить
- Удаляет элемент временной шкалы.
- получать
- Получает один элемент временной шкалы по идентификатору.
- вставлять
- Вставляет новый элемент на временную шкалу.
- список
- Извлекает список элементов временной шкалы для аутентифицированного пользователя.
- пластырь
- Обновляет элемент временной шкалы на месте. Этот метод поддерживает семантику исправления .
- обновлять
- Обновляет элемент временной шкалы на месте.