カレンダー
予定と招待。
カレンダーのツール
| ツール | 機能 |
|---|---|
| listCalendarEvents | 2 つの時点の間のすべての回。繰り返す予定は回ごとに 1 件ずつで、場所、状態、自分の返信付き。 |
| getCalendarEvent | 予定 1 件の全体。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文字まで