Để biết danh sách các phương thức cho tài nguyên này, hãy xem ở cuối trang.
Biểu diễn tài nguyên
Mỗi mục trong dòng thời gian của người dùng được biểu thị dưới dạng cấu trúc JSON TimelineItem
, như mô tả dưới đây.
{ "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 } }
Tên tài sản | Giá trị | Mô tả | Ghi chú |
---|---|---|---|
attachments[] |
list |
Danh sách tệp đính kèm nội dung nghe nhìn liên kết với mục này. Để thuận tiện, bạn có thể tham khảo các tệp đính kèm trong tải trọng HTML của mình bằng tệp đính kèm hoặc lược đồ cid. Ví dụ:
|
|
bundleId |
string |
Mã nhận dạng gói của mặt hàng này. Các dịch vụ có thể chỉ định bundleId để nhóm nhiều mục lại với nhau. Chúng xuất hiện bên dưới một mục cấp cao nhất trên thiết bị. | có thể ghi |
canonicalUrl |
string |
URL chính tắc trỏ đến phiên bản chuẩn/chất lượng cao của dữ liệu được biểu thị bằng mục dòng thời gian. | có thể ghi |
created |
datetime |
Thời điểm mục này được tạo, được định dạng theo RFC 3339. | |
creator |
nested object |
Người dùng hoặc nhóm đã tạo mục này. | có thể ghi |
displayTime |
datetime |
Thời gian sẽ xuất hiện khi người dùng xem mục này trong tiến trình, theo định dạng RFC 3339. Dòng thời gian của người dùng này được sắp xếp theo trình tự thời gian trong thời gian hiển thị, vì vậy, điều này cũng sẽ xác định vị trí mặt hàng được hiển thị trong dòng thời gian. Nếu dịch vụ không đặt thời gian hiển thị mặc định, thời gian hiển thị sẽ là thời gian updated . |
có thể ghi |
etag |
etag |
ETag cho mặt hàng này. | |
html |
string |
Nội dung HTML cho mục này. Nếu bạn cung cấp cả text và html cho một mục thì html sẽ hiển thị trong tiến trình. Phần tử HTML được phép – Bạn có thể sử dụng những phần tử này trong thẻ dòng thời gian của mình.
Các phần tử HTML bị chặn: Các phần tử này và nội dung trong đó bị xoá khỏi các phần tử HTML.
Các phần tử khác: Mọi phần tử không được liệt kê sẽ bị xoá, nhưng nội dung của các phần tử đó được giữ nguyên. |
có thể ghi |
id |
string |
Mã của mục dòng thời gian. Đây là chỉ số duy nhất trong dòng thời gian của người dùng. | |
inReplyTo |
string |
Nếu mục này được tạo dưới dạng câu trả lời cho một mục khác, trường này sẽ được đặt thành mã của mục đang được trả lời. Bạn có thể dùng tính năng này để đính kèm câu trả lời vào cuộc trò chuyện hoặc bài đăng thích hợp. | |
isBundleCover |
boolean |
Mục này có phải là ảnh bìa theo gói hay không. Nếu một mặt hàng được đánh dấu là bìa theo gói, thì đó sẽ là điểm truy cập đến nhóm các mặt hàng có cùng bundleId với mặt hàng đó. Thông báo sẽ chỉ hiển thị trên dòng thời gian chính, không phải trong gói đã mở.Trên dòng thời gian chính, các mục được hiển thị là:
|
có thể ghi |
isDeleted |
boolean |
Khi đúng, cho biết mục này đã bị xoá và chỉ thuộc tính mã nhận dạng được đặt. | |
isPinned |
boolean |
Nếu giá trị này là true, thì mục này sẽ cho biết mục này đã được ghim, có nghĩa là mục này được nhóm cùng với "đang hoạt động" các mục như điều hướng và Hangouts, ở phía đối diện của màn hình chính từ các mục dòng thời gian trước đây (không được ghim). Bạn có thể cho phép người dùng bật/tắt giá trị của thuộc tính này bằng mục TOGGLE_PINNED trong trình đơn tích hợp. |
|
kind |
string |
Loại tài nguyên. Thao tác này luôn là mirror#timelineItem . |
|
location |
nested object |
Vị trí địa lý liên kết với mục này. | có thể ghi |
menuItems[] |
list |
Danh sách các mục trong trình đơn sẽ được hiển thị cho người dùng khi mục này được chọn trong dòng thời gian. | có thể ghi |
menuItems[].action |
string |
Kiểm soát hành vi khi người dùng chọn một tuỳ chọn trong trình đơn. Các giá trị được phép là:
|
có thể ghi |
menuItems[].id |
string |
Mã nhận dạng cho mục này trong trình đơn. Mã này do ứng dụng tạo ra và được coi là mã thông báo mờ. | có thể ghi |
menuItems[].payload |
string |
Tải trọng chung có ý nghĩa thay đổi tuỳ thuộc vào thao tác của Mục trình đơn này.
|
có thể ghi |
menuItems[].removeWhenSelected |
boolean |
Nếu bạn đặt thành true cho một mục trong trình đơn CUSTOM , thì mục đó sẽ bị xoá khỏi trình đơn sau khi được chọn. |
có thể ghi |
menuItems[].values[] |
list |
Đối với các mục CUSTOM , danh sách giá trị kiểm soát giao diện của mục trong trình đơn ở mỗi trạng thái. Bạn phải cung cấp giá trị cho trạng thái DEFAULT . Nếu thiếu trạng thái PENDING hoặc CONFIRMED , các trạng thái này sẽ không xuất hiện. |
có thể ghi |
menuItems[].values[].displayName |
string |
Tên hiển thị cho mục trong trình đơn. Nếu bạn chỉ định thuộc tính này cho một mục trong trình đơn tích hợp sẵn, thì lệnh thoại theo ngữ cảnh mặc định cho mục đó trong trình đơn sẽ không hiển thị. | có thể ghi |
menuItems[].values[].iconUrl |
string |
URL của biểu tượng để hiển thị cùng với mục trong trình đơn. | có thể ghi |
menuItems[].values[].state |
string |
Trạng thái áp dụng giá trị này. Các giá trị được phép là:
|
có thể ghi |
notification |
nested object |
Kiểm soát cách hiện các thông báo về mục này trên thiết bị. Nếu thiếu thông tin này thì sẽ không có thông báo nào được tạo. | có thể ghi |
notification.deliveryTime |
datetime |
Thời điểm thông báo cần được gửi. | có thể ghi |
notification.level |
string |
Mô tả mức độ quan trọng của thông báo. Các giá trị được phép là:
|
có thể ghi |
pinScore |
integer |
Đối với các mục đã ghim, mục này xác định thứ tự hiển thị mục trong dòng thời gian, với điểm số cao hơn xuất hiện gần đồng hồ hơn. Lưu ý: việc đặt trường này hiện không được hỗ trợ. | |
recipients[] |
list |
Danh sách người dùng hoặc nhóm đã được chia sẻ mục này. | có thể ghi |
selfLink |
string |
URL có thể dùng để truy xuất mục này. | |
sourceItemId |
string |
Chuỗi mờ bạn có thể dùng để ánh xạ một mục dòng thời gian với dữ liệu trong dịch vụ của mình. | có thể ghi |
speakableText |
string |
Phiên bản có thể nói của nội dung của mục này. Cùng với mục trong trình đơn READ_ALOUD , hãy sử dụng trường này để cung cấp văn bản rõ ràng hơn khi được đọc to hoặc để cung cấp thông tin mở rộng về nội dung hiển thị trực quan trên Glass.Đồ thuỷ tinh cũng cần chỉ định trường SpeakableType. Trường này sẽ được nói trước văn bản này trong những trường hợp có ngữ cảnh bổ sung hữu ích, chẳng hạn như khi người dùng yêu cầu đọc to mục sau khi có thông báo. |
có thể ghi |
speakableType |
string |
Nội dung mô tả có thể nói về loại mục này. Thông báo này sẽ được thông báo cho người dùng trước khi đọc nội dung của mặt hàng trong trường hợp bối cảnh bổ sung hữu ích, chẳng hạn như khi người dùng yêu cầu đọc to mặt hàng sau khi có thông báo. Đây phải là một cụm danh từ ngắn, đơn giản như "Email", "Tin nhắn văn bản" hoặc "Tin tức hành tinh hằng ngày". Bạn nên điền sẵn trường này cho mọi mục trên dòng thời gian, ngay cả khi mục đó không chứa văn bản hoặc văn bản SpeakableText để người dùng có thể tìm hiểu loại mục mà không cần nhìn vào màn hình. |
có thể ghi |
text |
string |
Nội dung văn bản của mục này. | có thể ghi |
title |
string |
Tiêu đề của mục này. | có thể ghi |
updated |
datetime |
Thời điểm mục này được sửa đổi lần gần đây nhất, được định dạng theo RFC 3339. |
Phương thức
- xóa
- Xoá một mục trong dòng thời gian.
- nhận
- Lấy một mục trong dòng thời gian theo mã nhận dạng.
- chèn
- Chèn một mục mới vào dòng thời gian.
- list
- Truy xuất danh sách các mục trong dòng thời gian cho người dùng đã xác thực.
- bản vá
- Cập nhật một mục trong dòng thời gian tại chỗ. Phương thức này hỗ trợ ngữ nghĩa của bản vá.
- cập nhật
- Cập nhật một mục trong dòng thời gian tại chỗ.