Timeline

רשימה של ה-methods במשאב הזה מופיעה בסוף הדף.

ייצוגי משאבים

כל פריט בציר הזמן של המשתמש מיוצג במבנה 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 רשימה של קובצי מדיה מצורפים שמשויכים לפריט הזה. לנוחותכם, תוכלו להפנות לקבצים מצורפים במטענים ייעודיים (payloads) של HTML באמצעות הסכימה המצורפת או ה-cid. לדוגמה:
  • קובץ מצורף: <img src="attachment:attachment_index"> כאשר attachment_index הוא האינדקס מבוסס 0 של המערך הזה.
  • cid: <img src="cid:attachment_id"> כאשר attachment_id הוא המזהה של הקובץ המצורף.
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 מותרים – אפשר להשתמש ברכיבים האלה בכרטיסי ציר הזמן.

  • כותרות: h1, h2, h3, h4, h5, h6
  • תמונות: img
  • רשימות: li, ol, ul
  • סמנטיקה של HTML5: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time
  • מבני: blockquote, br, div, hr, p, span
  • סגנון: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup
  • טבלאות: table, tbody, td, tfoot, th, thead, tr

רכיבי HTML חסומים: הרכיבים האלה והתוכן שלהם יוסרו ממטענים ייעודיים (payloads) של HTML.

  • כותרות המסמכים: head, title
  • הטמעות: audio, embed, object, source, video
  • מסגרות: frame, frameset
  • כתיבת סקריפטים: applet, script

רכיבים אחרים: רכיבים שלא מופיעים ברשימה יוסרו, אבל התוכן שלהם יישמר.

ניתן לכתיבה
id string המזהה של הפריט בציר הזמן. הערך הזה ייחודי בציר הזמן של המשתמש.
inReplyTo string אם הפריט הזה נוצר כתשובה לפריט אחר, השדה הזה יוגדר כמזהה הפריט שאליו נשלחה התשובה. אפשר להשתמש כך כדי לצרף תשובה לשיחה או לפוסט המתאימים.
isBundleCover boolean האם הפריט הזה הוא שער חבילה.

אם פריט מסומן ככריכה של חבילה, הוא יהיה נקודת הכניסה לחבילת הפריטים שהbundleId שלהם זהה לפריט הזה. הוא יוצג רק בציר הזמן הראשי — לא בתוך החבילה הפתוחה.

בציר הזמן הראשי, הפריטים שמוצגים הם:
  • פריטים שבהם isBundleCover מוגדר ל-true
  • פריטים ללא bundleId
בציר הזמן של החבילה, הפריטים המוצגים הם:
  • פריטים שבהם המאפיין bundleId המדובר וגם isBundleCover מוגדר לערך false
ניתן לכתיבה
isDeleted boolean כאשר True, הפריט הזה נמחק, ורק הנכס של המזהה מוגדר.
isPinned boolean כאשר הערך הוא True, הפריט מוצמד, כלומר הוא מקובץ לצד 'פעיל'. פריטים כמו ניווט ו-Hangouts, בצד הנגדי של מסך הבית מפריטים היסטוריים של ציר הזמן (לא מוצמדים). ניתן לאפשר למשתמש להחליף את המצב של הערך של הנכס הזה באמצעות האפשרות TOGGLE_PINNED בתפריט המובנה.
kind string סוג המשאב. הערך הוא תמיד mirror#timelineItem.
location nested object המיקום הגיאוגרפי שמשויך לפריט הזה. ניתן לכתיבה
notification nested object המדיניות הזו קובעת איך ההתראות לגבי הפריט הזה יוצגו במכשיר. אם השדה הזה חסר, לא תיווצר התראה. ניתן לכתיבה
notification.deliveryTime datetime השעה שבה צריך למסור את ההתראה. ניתן לכתיבה
notification.level string מתארת את מידת החשיבות של ההתראה. הערכים המותרים הם:
  • DEFAULT – התראות על חשיבות ברירת מחדל. יושמע מנגנון צלצול כדי להתריע בפני המשתמשים.
ניתן לכתיבה
pinScore integer לגבי פריטים מוצמדים, ההגדרה הזו קובעת את הסדר שבו הפריט מוצג בציר הזמן, והציון הגבוה יותר מופיע קרוב יותר לשעון. הערה: הגדרת השדה הזה לא נתמכת כרגע.
recipients[] list רשימה של משתמשים או קבוצות שאיתם הפריט הזה שותף. ניתן לכתיבה
sourceItemId string מחרוזת אטומה שאפשר להשתמש בה כדי למפות פריט בציר הזמן לנתונים בשירות שלכם. ניתן לכתיבה
speakableText string גרסת הדיבור של תוכן הפריט הזה. בנוסף לאפשרות בתפריט READ_ALOUD, השתמשו בשדה הזה כדי לספק טקסט שיהיה ברור יותר בהקראה בקול, או כדי לספק מידע מורחב על התוכן שמוצג ב-Glass.

תוכנת Glassware צריכה לציין גם את השדה SpeakableType, שייאמר לפני הטקסט הזה במקרים שבהם ההקשר הנוסף מועיל. לדוגמה, כשהמשתמש מבקש להקריא את הפריט לאחר התראה.
ניתן לכתיבה
speakableType string תיאור קולי של סוג הפריט הזה. תוכרז על כך למשתמש לפני קריאת תוכן הפריט, במקרים שבהם ההקשר הנוסף מועיל, לדוגמה, כשהמשתמש מבקש הקראה של הפריט לאחר התראה.

זה צריך להיות ביטוי שם עצם קצר ופשוט, כמו "Email", "הודעת טקסט" או "Daily Planet News Update".

מומלץ להשתמש ב-Glass כדי לאכלס את השדה הזה בכל פריט בציר הזמן, גם אם הפריט לא מכיל טקסט SpeakableText או טקסט כדי שהמשתמש יוכל ללמוד על סוג הפריט בלי להסתכל במסך.
ניתן לכתיבה
text string תוכן הטקסט של הפריט הזה. ניתן לכתיבה
title string הכותרת של הפריט הזה. ניתן לכתיבה
updated datetime השעה שבה הפריט הזה שונה לאחרונה, בפורמט שתואם לתקן RFC 3339.

שיטות

מחיקה
מוחק פריט מציר הזמן.
הורדה
מקבלת פריט אחד בציר הזמן לפי מזהה.
הוספה
מוסיף פריט חדש לציר הזמן.
list
אחזור רשימה של פריטים בציר הזמן של המשתמש המאומת.
תיקון
מעדכנת פריט בציר הזמן. השיטה הזו תומכת בסמנטיקה של תיקונים.
עדכון
מעדכנת פריט בציר הזמן.