CalendarList

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

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

بازنمایی منابع 

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": 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 " - مالکیت تقویم را فراهم می کند. این نقش دارای تمام مجوزهای نقش نویسنده با توانایی اضافی برای دیدن و دستکاری ACLها است.
backgroundColor string رنگ اصلی تقویم در قالب هگزادسیمال " #0088aa ". این ویژگی جایگزین خاصیت colorId مبتنی بر شاخص می‌شود. برای تنظیم یا تغییر این ویژگی، باید colorRgbFormat=true را در پارامترهای متدهای insert ، update و patch مشخص کنید. اختیاری. قابل نوشتن
colorId string رنگ تقویم. این شناسه ای است که به ورودی در بخش calendar تعریف رنگ ها اشاره دارد ( نقطه پایانی رنگ ها را ببینید). این ویژگی با ویژگی های backgroundColor و foregroundColor جایگزین می شود و هنگام استفاده از این ویژگی ها می توان نادیده گرفت. اختیاری. قابل نوشتن
conferenceProperties nested object ویژگی های کنفرانس برای این تقویم، به عنوان مثال چه نوع کنفرانس هایی مجاز هستند.
conferenceProperties. allowedConferenceSolutionTypes[] list انواع راهکارهای کنفرانسی که برای این تقویم پشتیبانی می شوند.

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

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

defaultReminders[] list یادآوری های پیش فرضی که کاربر احراز هویت شده برای این تقویم دارد. قابل نوشتن
defaultReminders[]. method string روش استفاده شده توسط این یادآوری. مقادیر ممکن عبارتند از:
  • " email " - یادآوری ها از طریق ایمیل ارسال می شوند.
  • " popup " - یادآوری ها از طریق یک پنجره بازشو UI ارسال می شوند.

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

 قابل نوشتن
defaultReminders[]. minutes integer تعداد دقیقه‌های قبل از شروع رویداد که یادآور باید راه‌اندازی شود. مقادیر معتبر بین 0 تا 40320 (4 هفته در دقیقه) هستند.

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

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

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

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

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

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

روش ها

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