Calendário
Eventos e convites.
Ferramentas de calendário
| Ferramenta | O que faz |
|---|---|
| listCalendarEvents | Cada ocorrência entre dois momentos, um evento que se repete uma vez por cada vez que acontece, com o local, o estado e a sua resposta. |
| getCalendarEvent | Um evento completo, por id ou pelo threadId da conversa que traz o seu convite: os participantes e as respostas, como se repete e os lembretes. |
| createCalendarEvent | Coloca um evento no calendário e convida os participantes a partir de um endereço de onde pode enviar. No chat da app pergunta primeiro, a menos que o tenha pedido. |
| updateCalendarEvent | Altera um evento que organiza e envia a atualização a todos os convidados. No chat da app pergunta primeiro, a menos que o tenha pedido. |
| cancelCalendarEvent | Cancela uma reunião que organiza e avisa todos os convidados. No chat da app pergunta sempre primeiro. |
| deleteCalendarEvent | Retira um evento do calendário sem avisar ninguém. No chat da app pergunta sempre primeiro. |
| respondToCalendarEvent | Aceita, recusa ou aceita provisoriamente um convite, e avisa o organizador. No chat da app pergunta primeiro, a menos que o tenha pedido. |
Ler requer calendar:read e cada alteração calendar:write. Tudo o que envia um email a alguém também requer emails:send: convidar, atualizar ou cancelar uma reunião com participantes, e cada resposta a um convite.
Um cliente limitado a alguns endereços só vê e altera os eventos que um deles organiza ou em que participa, e só envia a partir deles.
Referência
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.
Entradas
fromstringObrigatório- Formato
date-time tostringObrigatório- Formato
date-time timezonestring- De 1 a 64 caracteres
limitinteger- Pelo menos 1No máximo 200
offsetinteger- Pelo menos 0
Também disponível em
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.
Entradas
idstring- De 1 a 64 caracteres
threadIdstring- De 1 a 256 caracteres
Também disponível em
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.
Entradas
summarystringObrigatório- De 1 a 255 caracteres
startstringObrigatório- Formato
date-time endstringObrigatório- Formato
date-time descriptionstring- Até 8000 caracteres
locationstring- Até 255 caracteres
urlstring- Até 2000 caracteresFormato
uri allDaybooleantimezonestring- De 1 a 64 caracteres
recurrencestring- Até 512 caracteres
attendeesobject[]- Até 200 itens
emailstringObrigatório- Até 320 caracteresFormato
email namestring- Até 128 caracteres
optionalboolean
remindersobject[]- Até 5 itens
minutesBeforeintegerObrigatório- Pelo menos 0No máximo 40320
sendInvitesbooleanfromstring- Até 320 caracteres
Também disponível em
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.
Entradas
idstringObrigatório- De 1 a 64 caracteres
summarystring- De 1 a 255 caracteres
startstring- Formato
date-time endstring- Formato
date-time descriptionstring- Até 8000 caracteres
locationstring- Até 255 caracteres
urlstring- Até 2000 caracteresFormato
uri allDaybooleantimezonestring- De 1 a 64 caracteres
recurrencestring- Até 512 caracteres
attendeesobject[]- Até 200 itens
emailstringObrigatório- Até 320 caracteresFormato
email namestring- Até 128 caracteres
optionalboolean
remindersobject[]- Até 5 itens
minutesBeforeintegerObrigatório- Pelo menos 0No máximo 40320
sendInvitesbooleanfromstring- Até 320 caracteres
Também disponível em
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.
Entradas
idstringObrigatório- De 1 a 64 caracteres
fromstring- Até 320 caracteres
Também disponível em
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.
Entradas
idstringObrigatório- De 1 a 64 caracteres
Também disponível em
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.
Entradas
idstringObrigatório- De 1 a 64 caracteres
responsestringObrigatório- Um de
"ACCEPTED""DECLINED""TENTATIVE" respondingAsstring- Até 320 caracteres