Calendrier
Les événements et les invitations.
Outils Calendrier
| Outil | Ce qu'il fait |
|---|---|
| listCalendarEvents | Chaque occurrence entre deux instants, un événement récurrent une fois pour chaque fois qu’il a lieu, avec son lieu, son état et votre réponse. |
| getCalendarEvent | Un événement complet, par id ou par le threadId de la conversation qui porte son invitation : les participants et leurs réponses, sa récurrence et ses rappels. |
| createCalendarEvent | Mettre un événement au calendrier et inviter les participants depuis une adresse depuis laquelle vous pouvez envoyer. Dans le chat de l’application, il demande d’abord sauf si vous l’avez demandé. |
| updateCalendarEvent | Modifier un événement que vous organisez et envoyer la mise à jour à tous les invités. Dans le chat de l’application, il demande d’abord sauf si vous l’avez demandé. |
| cancelCalendarEvent | Annuler une réunion que vous organisez et prévenir tous les invités. Dans le chat de l’application, il demande toujours d’abord. |
| deleteCalendarEvent | Retirer un événement du calendrier sans prévenir personne. Dans le chat de l’application, il demande toujours d’abord. |
| respondToCalendarEvent | Accepter, refuser ou accepter provisoirement une invitation, et prévenir l’organisateur. Dans le chat de l’application, il demande d’abord sauf si vous l’avez demandé. |
Lire nécessite calendar:read et chaque modification calendar:write. Tout ce qui envoie un e-mail à quelqu’un nécessite aussi emails:send : inviter, mettre à jour ou annuler une réunion avec des participants, et chaque réponse à une invitation.
Un client limité à certaines adresses ne voit et ne modifie que les événements que l’une d’elles organise ou auxquels elle participe, et n’envoie que depuis elles.
Référence
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.
Entrées
fromstringObligatoire- Format
date-time tostringObligatoire- Format
date-time timezonestring- De 1 à 64 caractères
limitinteger- Au moins 1Au plus 200
offsetinteger- Au moins 0
Aussi disponible dans
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.
Entrées
idstring- De 1 à 64 caractères
threadIdstring- De 1 à 256 caractères
Aussi disponible dans
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.
Entrées
summarystringObligatoire- De 1 à 255 caractères
startstringObligatoire- Format
date-time endstringObligatoire- Format
date-time descriptionstring- Jusqu'à 8000 caractères
locationstring- Jusqu'à 255 caractères
urlstring- Jusqu'à 2000 caractèresFormat
uri allDaybooleantimezonestring- De 1 à 64 caractères
recurrencestring- Jusqu'à 512 caractères
attendeesobject[]- Jusqu'à 200 éléments
emailstringObligatoire- Jusqu'à 320 caractèresFormat
email namestring- Jusqu'à 128 caractères
optionalboolean
remindersobject[]- Jusqu'à 5 éléments
minutesBeforeintegerObligatoire- Au moins 0Au plus 40320
sendInvitesbooleanfromstring- Jusqu'à 320 caractères
Aussi disponible dans
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.
Entrées
idstringObligatoire- De 1 à 64 caractères
summarystring- De 1 à 255 caractères
startstring- Format
date-time endstring- Format
date-time descriptionstring- Jusqu'à 8000 caractères
locationstring- Jusqu'à 255 caractères
urlstring- Jusqu'à 2000 caractèresFormat
uri allDaybooleantimezonestring- De 1 à 64 caractères
recurrencestring- Jusqu'à 512 caractères
attendeesobject[]- Jusqu'à 200 éléments
emailstringObligatoire- Jusqu'à 320 caractèresFormat
email namestring- Jusqu'à 128 caractères
optionalboolean
remindersobject[]- Jusqu'à 5 éléments
minutesBeforeintegerObligatoire- Au moins 0Au plus 40320
sendInvitesbooleanfromstring- Jusqu'à 320 caractères
Aussi disponible dans
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.
Entrées
idstringObligatoire- De 1 à 64 caractères
fromstring- Jusqu'à 320 caractères
Aussi disponible dans
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.
Entrées
idstringObligatoire- De 1 à 64 caractères
Aussi disponible dans
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.
Entrées
idstringObligatoire- De 1 à 64 caractères
responsestringObligatoire- L'un de
"ACCEPTED""DECLINED""TENTATIVE" respondingAsstring- Jusqu'à 320 caractères