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