برای لیست روش های این منبع، انتهای این صفحه را ببینید.
بازنمایی منابع
هر مورد در جدول زمانی کاربر به عنوان یک ساختار TimelineItem
JSON نشان داده می شود که در زیر توضیح داده شده است.
{ "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 | وقتی درست است، نشان می دهد که این مورد حذف شده است و فقط ویژگی ID تنظیم شده است. | |
isPinned | boolean | وقتی درست است، نشان میدهد که این مورد پین شده است، به این معنی که در کنار موارد «فعال» مانند پیمایش و پاتوقها، در طرف مقابل صفحه اصلی از موارد تاریخی (غیر پینشده) جدول زمانی گروهبندی شده است. میتوانید به کاربر اجازه دهید مقدار این ویژگی را با آیتم منوی داخلی TOGGLE_PINNED تغییر دهد. | |
kind | string | نوع منبع. این همیشه mirror#timelineItem است. | |
location | nested object | موقعیت جغرافیایی مرتبط با این مورد. | قابل نوشتن |
menuItems[] | list | لیستی از آیتم های منو که با انتخاب این مورد در جدول زمانی به کاربر ارائه می شود. | قابل نوشتن |
menuItems[]. action | string | هنگامی که کاربر گزینه منو را انتخاب می کند، رفتار را کنترل می کند. مقادیر مجاز عبارتند از:
| قابل نوشتن |
menuItems[]. id | string | شناسه این آیتم منو. این توسط برنامه ایجاد می شود و به عنوان یک نشانه غیر شفاف در نظر گرفته می شود. | قابل نوشتن |
menuItems[]. payload | string | یک بار عمومی که معنای آن بسته به عملکرد این MenuItem تغییر می کند.
| قابل نوشتن |
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 ، از این فیلد برای ارائه متنی که هنگام خواندن با صدای بلند واضحتر باشد، یا برای ارائه اطلاعات گستردهتر به آنچه به صورت بصری روی شیشه نمایش داده میشود، استفاده کنید.Glassware همچنین باید فیلد speakableType را مشخص کند، که در مواردی که زمینه اضافی مفید است، قبل از این متن گفته میشود، برای مثال زمانی که کاربر درخواست میکند که مورد پس از یک اعلان با صدای بلند خوانده شود. | قابل نوشتن |
speakableType | string | توضیحات قابل گفتن از نوع این مورد. در مواردی که زمینه اضافی مفید باشد، برای مثال زمانی که کاربر درخواست می کند که پس از یک اعلان، مطلب را با صدای بلند خوانده شود، این موضوع قبل از خواندن محتوای مورد به کاربر اعلام می شود. این باید یک عبارت اسمی کوتاه و ساده مانند «ایمیل»، «پیام متنی» یا «بهروزرسانی روزانه سیاره نیوز» باشد. از ظروف شیشهای تشویق میشود که این فیلد را برای هر آیتم جدول زمانی پر کنند، حتی اگر مورد حاوی speakableText یا متن نباشد تا کاربر بتواند نوع مورد را بدون نگاه کردن به صفحه یاد بگیرد. | قابل نوشتن |
text | string | محتوای متنی این آیتم | قابل نوشتن |
title | string | عنوان این مورد. | قابل نوشتن |
updated | datetime | زمانی که این مورد آخرین بار تغییر کرده است، با فرمت RFC 3339. |
روش ها
- حذف کنید
- یک مورد جدول زمانی را حذف می کند.
- دریافت کنید
- یک آیتم جدول زمانی را با شناسه دریافت می کند.
- درج کنید
- یک مورد جدید را در جدول زمانی درج می کند.
- فهرست
- لیستی از موارد جدول زمانی را برای کاربر تأیید شده بازیابی می کند.
- پچ
- یک مورد جدول زمانی را در جای خود به روز می کند. این روش از معنای پچ پشتیبانی می کند.
- به روز رسانی کنید
- یک مورد جدول زمانی را در جای خود به روز می کند.