CalendarList

مجموعه‌ای از تقویم‌ها در فهرست تقویم کاربر. همچنین به بخش Calendars در مقابل CalendarList مراجعه کنید .

برای فهرست روش‌های این منبع، به انتهای این صفحه مراجعه کنید.

نمایش منابع 

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
نام ملک ارزش توضیحات یادداشت‌ها
accessRole string نقش دسترسی مؤثری که کاربر احراز هویت شده در تقویم دارد. فقط خواندنی. مقادیر ممکن عبارتند از:
  • « freeBusyReader » - دسترسی خواندن به اطلاعات آزاد/مشغول را فراهم می‌کند.
  • « reader » - دسترسی خواندن تقویم را فراهم می‌کند. رویدادهای خصوصی برای کاربرانی که دسترسی خواننده دارند نمایش داده می‌شوند، اما جزئیات رویداد پنهان خواهد بود.
  • « writer » - دسترسی خواندن و نوشتن به تقویم را فراهم می‌کند. رویدادهای خصوصی برای کاربرانی که دسترسی نویسنده دارند نمایش داده می‌شوند و جزئیات رویداد قابل مشاهده خواهد بود.
  • « owner » - دسترسی مدیر به تقویم را فراهم می‌کند. این نقش تمام مجوزهای نقش نویسنده را به همراه قابلیت اضافی مشاهده و تغییر سطوح دسترسی سایر کاربران دارد.

backgroundColor string رنگ اصلی تقویم در قالب هگزادسیمال " #0088aa ". این ویژگی جایگزین ویژگی colorId مبتنی بر شاخص می‌شود. برای تنظیم یا تغییر این ویژگی، باید colorRgbFormat=true در پارامترهای متدهای insert ، update و patch مشخص کنید. اختیاری است. قابل نوشتن
colorId string رنگ تقویم. این یک شناسه است که به ورودی در بخش calendar تعریف رنگ‌ها اشاره می‌کند (به نقطه پایانی رنگ‌ها مراجعه کنید). این ویژگی توسط ویژگی‌های backgroundColor و foregroundColor جایگزین شده است و هنگام استفاده از این ویژگی‌ها می‌توان آن‌ها را نادیده گرفت. اختیاری. قابل نوشتن
conferenceProperties nested object ویژگی‌های کنفرانس برای این تقویم، مثلاً چه نوع کنفرانس‌هایی مجاز هستند.
conferenceProperties. allowedConferenceSolutionTypes[] list انواع راهکارهای کنفرانس که برای این تقویم پشتیبانی می‌شوند.

مقادیر ممکن عبارتند از:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
اختیاری.

dataOwner string ایمیل صاحب تقویم. فقط برای تقویم‌های ثانویه تنظیم شده است. فقط خواندنی.
defaultReminders[] list یادآوری‌های پیش‌فرضی که کاربر احراز هویت‌شده برای این تقویم دارد. قابل نوشتن
defaultReminders[]. method string روشی که این یادآوری استفاده می‌کند. مقادیر ممکن عبارتند از:
  • « email » - یادآوری‌ها از طریق ایمیل ارسال می‌شوند.
  • « popup » - یادآوری‌ها از طریق یک پنجره بازشو در رابط کاربری ارسال می‌شوند.

هنگام اضافه کردن یادآوری الزامی است.

 قابل نوشتن
defaultReminders[]. minutes integer تعداد دقایق قبل از شروع رویداد که یادآوری باید فعال شود. مقادیر معتبر بین ۰ تا ۴۰۳۲۰ (۴ هفته به دقیقه) هستند.

هنگام اضافه کردن یادآوری الزامی است.

 قابل نوشتن
deleted boolean آیا این ورودی لیست تقویم از لیست تقویم حذف شده است یا خیر. فقط خواندنی. اختیاری. پیش‌فرض False است.
description string شرح تقویم. اختیاری. فقط خواندنی.
etag etag برچسب منبع (ETag).
foregroundColor string رنگ پیش‌زمینه تقویم در قالب هگزادسیمال " #ffffff ". این ویژگی جایگزین ویژگی colorId مبتنی بر شاخص می‌شود. برای تنظیم یا تغییر این ویژگی، باید colorRgbFormat=true در پارامترهای متدهای insert ، update و patch مشخص کنید. اختیاری است. قابل نوشتن
hidden boolean اینکه آیا تقویم از لیست پنهان شده است یا خیر. اختیاری. این ویژگی فقط زمانی برگردانده می‌شود که تقویم پنهان شده باشد، که در این صورت مقدار آن true است. قابل نوشتن
id string شناسه تقویم.
kind string نوع منبع ("تقویم#تقویم_لیست_ورودی").
location string موقعیت جغرافیایی تقویم به صورت متن آزاد. اختیاری. فقط خواندنی.
notificationSettings object اعلان‌هایی که کاربر احراز هویت شده برای این تقویم دریافت می‌کند. قابل نوشتن
notificationSettings. notifications[] list فهرست اعلان‌های تنظیم‌شده برای این تقویم.
notificationSettings.notifications[]. method string روشی که برای ارائه اعلان استفاده می‌شود. مقدار ممکن:
  • « email » - اعلان‌ها از طریق ایمیل ارسال می‌شوند.

هنگام افزودن اعلان الزامی است.

 قابل نوشتن
notificationSettings.notifications[]. type string نوع اعلان. مقادیر ممکن عبارتند از:
  • « eventCreation » - هنگام اضافه شدن یک رویداد جدید به تقویم، اعلان ارسال می‌شود.
  • « eventChange » - اعلانی که هنگام تغییر یک رویداد ارسال می‌شود.
  • « eventCancellation » - اعلانی که هنگام لغو یک رویداد ارسال می‌شود.
  • « eventResponse » - اعلانی که هنگام پاسخ دادن یک شرکت‌کننده به دعوت رویداد ارسال می‌شود.
  • « agenda » - دستور کاری با رویدادهای روز (که صبح ارسال می‌شود).

هنگام افزودن اعلان الزامی است.

 قابل نوشتن
primary boolean اینکه آیا تقویم، تقویم اصلی کاربر احراز هویت شده است یا خیر. فقط خواندنی. اختیاری. مقدار پیش‌فرض False است.
selected boolean اینکه آیا محتوای تقویم در رابط کاربری تقویم نمایش داده شود یا خیر. اختیاری. مقدار پیش‌فرض False است. قابل نوشتن
summary string عنوان تقویم. فقط خواندنی.
summaryOverride string خلاصه‌ای که کاربر احراز هویت شده برای این تقویم تنظیم کرده است. اختیاری. قابل نوشتن
timeZone string منطقه زمانی تقویم. اختیاری. فقط خواندنی.

روش‌ها

حذف
یک تقویم را از فهرست تقویم‌های کاربر حذف می‌کند.
دریافت
یک تقویم از لیست تقویم‌های کاربر برمی‌گرداند.
درج
یک تقویم موجود را در فهرست تقویم‌های کاربر درج می‌کند.
فهرست
تقویم‌های موجود در لیست تقویم کاربر را برمی‌گرداند.
پچ
یک تقویم موجود در فهرست تقویم کاربر را به‌روزرسانی می‌کند. این روش از معنای وصله (patch semantics) پشتیبانی می‌کند. توجه داشته باشید که هر درخواست وصله سه واحد سهمیه مصرف می‌کند؛ بهتر است از get و به دنبال آن update استفاده کنید. مقادیر فیلدی که مشخص می‌کنید جایگزین مقادیر موجود می‌شوند. فیلدهایی که در درخواست مشخص نمی‌کنید بدون تغییر باقی می‌مانند. فیلدهای آرایه، در صورت مشخص شدن، آرایه‌های موجود را بازنویسی می‌کنند. این کار عناصر آرایه قبلی را حذف می‌کند.
به‌روزرسانی
یک تقویم موجود در فهرست تقویم‌های کاربر را به‌روزرسانی می‌کند.
تماشا کنید
منتظر تغییرات در منابع CalendarList باشید.