לקבלת רשימה של שיטות עבור המשאב הזה, אפשר לעיין בסוף הדף.
ייצוגי משאבים
כל פריט בציר הזמן של המשתמש מיוצג כמבנה 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 |
רשימה של קובצי מדיה מצורפים המשויכים לפריט הזה. מטעמי נוחות, אפשר להפנות לקבצים מצורפים במטען הייעודי (payload) של ה-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 חסומים: הרכיבים האלה והתוכן שלהם נמחקים ממטענים ייעודיים (payload) של HTML.
רכיבים אחרים: אלמנטים שאינם רשומים מוסרים, אבל התוכן שלהם נשמר. |
ניתן לכתיבה |
id |
string |
המזהה של פריט ציר הזמן. הערך הזה ייחודי בציר הזמן של המשתמש. | |
inReplyTo |
string |
אם הפריט הזה נוצר כתשובה לפריט אחר, השדה הזה יוגדר כמזהה של הפריט שאליו נענית. אפשר להשתמש בזה כדי לצרף תשובה לשיחה או לפוסט המתאימים. | |
isBundleCover |
boolean |
האם הפריט הזה הוא עטיפת חבילה. אם פריט מסומן ככיסוי חבילה, הוא ישמש כנקודת הכניסה לחבילת הפריטים שיש להם bundleId זהה לפריט הזה. הוא יוצג רק בציר הזמן הראשי – לא בחבילה הפתוחה.בציר הזמן הראשי, הפריטים המוצגים הם:
|
ניתן לכתיבה |
isDeleted |
boolean |
אם היא מוגדרת כ-True, הפריט הזה נמחק ורק המאפיין 'מזהה' מוגדר. | |
isPinned |
boolean |
כשהאפשרות מוגדרת כ-True, הפריט הזה מוצמד, כלומר הוא מקובצים לצד פריטים "פעילים" כמו ניווט ו-Hangouts, בצד הנגדי של מסך הבית מפריטי ציר זמן היסטוריים (שאינם מוצמדים). אתם יכולים לאפשר למשתמשים להחליף את הערך של הנכס הזה באמצעות אפשרות התפריט המובנית ב-TOGGLE_PINNED . |
|
kind |
string |
סוג המשאב. תמיד mirror#timelineItem . |
|
location |
nested object |
המיקום הגיאוגרפי המשויך לפריט זה. | ניתן לכתיבה |
menuItems[] |
list |
רשימה של אפשרויות תפריט שיוצגו למשתמש כאשר הפריט הזה נבחר בציר הזמן. | ניתן לכתיבה |
menuItems[].action |
string |
המדיניות קובעת את ההתנהגות כשהמשתמש בוחר את התפריט. הערכים המותרים הם:
|
ניתן לכתיבה |
menuItems[].id |
string |
המזהה של פריט זה בתפריט. האפליקציה הזו יוצרת אסימון אטום. | ניתן לכתיבה |
menuItems[].payload |
string |
מטען ייעודי (payload) כללי שהמשמעות שלו משתנה בהתאם לפעולה של פריט התפריט הזה.
|
ניתן לכתיבה |
menuItems[].removeWhenSelected |
boolean |
אם המדיניות מקבלת את הערך true עבור פריט בתפריט CUSTOM , הפריט הזה יוסר מהתפריט לאחר בחירתו. |
ניתן לכתיבה |
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.כלי הזכוכית צריך גם לציין את שדה ה-SpeakableType, שיוקרא לפני הטקסט הזה במקרים שבהם ההקשר הנוסף שימושי, לדוגמה כאשר המשתמש מבקש שפריט יוקרא בקול לאחר התראה. |
ניתן לכתיבה |
speakableType |
string |
תיאור של סוג הפריט, שניתן לבטא אותו. הוא יודיע למשתמש לפני קריאת תוכן הפריט במקרים שבהם ההקשר הנוסף שימושי, למשל כאשר המשתמש מבקש להקריא את הפריט לאחר קבלת הודעה. עליו להיות ביטוי קצר ופשוט של שם עצם, כגון "אימייל", "הודעת טקסט", או "עדכון יומי של כוכבי לכת". מומלץ להזין את Glassware עבור השדה הזה עבור כל פריט בציר הזמן, גם אם הפריט לא מכיל SpeakableText או טקסט כדי שהמשתמש יוכל ללמוד את סוג הפריט בלי להסתכל במסך. |
ניתן לכתיבה |
text |
string |
תוכן הטקסט של הפריט הזה. | ניתן לכתיבה |
title |
string |
הכותרת של פריט זה. | ניתן לכתיבה |
updated |
datetime |
המועד שבו הפריט נערך לאחרונה, בהתאם לפורמט של RFC 3339. |