التقويم
الأحداث والدعوات.
أدوات التقويم
| الأداة | ما تفعله |
|---|---|
| listCalendarEvents | كل موعد بين لحظتين، والحدث المتكرر مرة لكل مرة يقع فيها، مع مكانه وحالته وردّك. |
| getCalendarEvent | حدث واحد كاملًا، عبر id أو عبر threadId للمحادثة التي تحمل دعوته: الحضور وردودهم، وكيف يتكرر، وتذكيراته. |
| createCalendarEvent | ضع حدثًا في التقويم وادعُ الحضور من عنوان يحق لك الإرسال منه. وفي دردشة التطبيق يسأل أولًا ما لم تطلب ذلك. |
| updateCalendarEvent | يغيّر حدثًا تنظّمه ويرسل التحديث إلى كل المدعوين. وفي دردشة التطبيق يسأل أولًا ما لم تطلب ذلك. |
| cancelCalendarEvent | يلغي اجتماعًا تنظّمه ويخبر كل المدعوين. وفي دردشة التطبيق يسأل دائمًا أولًا. |
| deleteCalendarEvent | يزيل حدثًا من التقويم دون إخبار أحد. وفي دردشة التطبيق يسأل دائمًا أولًا. |
| respondToCalendarEvent | يقبل دعوة أو يرفضها أو يقبلها مبدئيًا، ويخبر المنظِّم. وفي دردشة التطبيق يسأل أولًا ما لم تطلب ذلك. |
القراءة تتطلب calendar:read وكل تغيير يتطلب calendar:write. وكل ما يرسل بريدًا إلى أحد يتطلب أيضًا emails:send: دعوة الحضور إلى اجتماع أو تحديثه أو إلغاؤه، وكل رد على دعوة.
العميل المقصور على بعض العناوين لا يرى ولا يغيّر إلا الأحداث التي ينظّمها أحدها أو يحضرها، ولا يرسل إلا منها.
المرجع
listCalendarEvents
The calendar between two moments, as the Calendar page of the app shows it: every occurrence in the window, a repeating event once for each time it happens, sorted by start, with its event id, place, status and your answer. from and to are ISO 8601 with a zone, at most a year apart, and timezone (an IANA zone, UTC unless you say) decides what an all-day event means. When more follow, the last line gives the offset to pass back.
المدخلات
fromstringمطلوب- التنسيق
date-time tostringمطلوب- التنسيق
date-time timezonestring- من 1 إلى 64 من الأحرف
limitinteger- على الأقل 1على الأكثر 200
offsetinteger- على الأقل 0
متاح أيضًا في
getCalendarEvent
One calendar event in full: when it is, where, who organised it, every attendee and their answer, your own answer, how it repeats and its reminders. Pass id for an event from listCalendarEvents, or threadId for the invitation a conversation carries.
المدخلات
idstring- من 1 إلى 64 من الأحرف
threadIdstring- من 1 إلى 256 من الأحرف
متاح أيضًا في
createCalendarEvent
Put an event on the calendar, as New event on the Calendar page does. start and end are ISO 8601 with a zone. With attendees, an invitation goes to each of them from the address in from, which has to be one you may send as, unless sendInvites is false. reminders takes minutes before the start, and recurrence an RRULE such as FREQ=WEEKLY;BYDAY=MO.
المدخلات
summarystringمطلوب- من 1 إلى 255 من الأحرف
startstringمطلوب- التنسيق
date-time endstringمطلوب- التنسيق
date-time descriptionstring- حتى 8000 من الأحرف
locationstring- حتى 255 من الأحرف
urlstring- حتى 2000 من الأحرفالتنسيق
uri allDaybooleantimezonestring- من 1 إلى 64 من الأحرف
recurrencestring- حتى 512 من الأحرف
attendeesobject[]- حتى 200 من العناصر
emailstringمطلوب- حتى 320 من الأحرفالتنسيق
email namestring- حتى 128 من الأحرف
optionalboolean
remindersobject[]- حتى 5 من العناصر
minutesBeforeintegerمطلوب- على الأقل 0على الأكثر 40320
sendInvitesbooleanfromstring- حتى 320 من الأحرف
متاح أيضًا في
updateCalendarEvent
Change an event you organise: its title, time, place, attendees, reminders or repeating. A field left out keeps its value, and attendees replaces the whole list. Everyone invited gets the updated invitation unless sendInvites is false.
المدخلات
idstringمطلوب- من 1 إلى 64 من الأحرف
summarystring- من 1 إلى 255 من الأحرف
startstring- التنسيق
date-time endstring- التنسيق
date-time descriptionstring- حتى 8000 من الأحرف
locationstring- حتى 255 من الأحرف
urlstring- حتى 2000 من الأحرفالتنسيق
uri allDaybooleantimezonestring- من 1 إلى 64 من الأحرف
recurrencestring- حتى 512 من الأحرف
attendeesobject[]- حتى 200 من العناصر
emailstringمطلوب- حتى 320 من الأحرفالتنسيق
email namestring- حتى 128 من الأحرف
optionalboolean
remindersobject[]- حتى 5 من العناصر
minutesBeforeintegerمطلوب- على الأقل 0على الأكثر 40320
sendInvitesbooleanfromstring- حتى 320 من الأحرف
متاح أيضًا في
cancelCalendarEvent
Call off a meeting you organise, as Cancel meeting does in the app: it stays on the calendar marked cancelled, and everyone invited is told it is off, from the address in from. A chat always asks first.
المدخلات
idstringمطلوب- من 1 إلى 64 من الأحرف
fromstring- حتى 320 من الأحرف
متاح أيضًا في
deleteCalendarEvent
Remove an event from the calendar for good, as Remove does in the app. Nobody else is told, so call off a meeting with others in it with cancelCalendarEvent instead. A chat always asks first.
المدخلات
idstringمطلوب- من 1 إلى 64 من الأحرف
متاح أيضًا في
respondToCalendarEvent
Answer an invitation: ACCEPTED, DECLINED or TENTATIVE. The answer goes to the organiser by email from the invited address you may send as, or from respondingAs when the invitation went to more than one of yours.
المدخلات
idstringمطلوب- من 1 إلى 64 من الأحرف
responsestringمطلوب- أحد
"ACCEPTED""DECLINED""TENTATIVE" respondingAsstring- حتى 320 من الأحرف