Lembretes e notificações

A API Google Calendar oferece suporte a lembretes e notificações.

  • Lembretes são alarmes acionados em um horário especificado antes do início de um evento.
  • Notificações permitem que os usuários saibam sobre mudanças nos eventos da agenda.

Não confunda notificações com notificações push, que notificam outro servidor sobre mudanças em uma agenda em vez de serem entregues a um usuário.

Para mais detalhes sobre as notificações no Google Agenda, consulte Modificar as notificações do Google Agenda.

Lembretes

Um lembrete consiste em:

  • Quando mostrar o lembrete, expresso em minutos antes do horário de início do evento.
  • O método de entrega a ser usado (consulte Mecanismos de entrega).

Os lembretes podem ser especificados para agendas inteiras e para eventos individuais. Os usuários podem definir lembretes padrão para cada uma das agendas. Esses padrões se aplicam a todos os eventos dessa agenda. No entanto, os usuários também podem substituir esses padrões para eventos individuais, substituindo-os por um conjunto diferente de lembretes.

Lembretes padrão

Os lembretes são informações particulares, específicas de um usuário autenticado. Eles não são compartilhados entre vários usuários. O resultado disso é o seguinte:

  • Os lembretes padrão são manipulados pela coleção CalendarList, que contém metadados de agenda específicos do usuário.
  • Eles não podem ser acessados pela coleção Calendars, que contém metadados globais compartilhados entre todos os usuários.

Os lembretes padrão também são retornados ao fazer uma consulta de lista de eventos.

Como substituir lembretes padrão

Para substituir os lembretes padrão ao criar ou atualizar um evento, defina reminders.useDefault como false e preencha reminders.overrides com o novo conjunto de lembretes. As substituições só podem ser definidas quando useDefault é false, conforme mostrado no exemplo a seguir:

"reminders": {
  "useDefault": false,
  "overrides": [
    {
      "method": "reminderMethod",
      "minutes": "reminderMinutes"
    }
  ]
}

Para reverter ao conjunto padrão de lembretes, faça uma atualização definindo reminders.useDefault de volta para true.

Notificações

O Google Agenda oferece suporte aos seguintes tipos de notificação:

  • Criação de eventos: um novo evento é adicionado a uma das agendas do usuário.
  • Mudança no evento: o organizador modificou um evento para o qual o usuário foi convidado.
  • Cancelamento de eventos: um evento para o qual o usuário foi convidado é cancelado.
  • Resposta do convidado: um convidado mudou o status da resposta para um evento criado pelo usuário.
  • Agenda: uma lista de todos os eventos na agenda do usuário, enviada no início do dia.

O usuário pode decidir quais notificações ativar por agenda e o método de entrega para cada tipo de notificação. Essas configurações não são compartilhadas com outros usuários. Assim como os lembretes padrão, elas podem ser acessadas pela coleção CalendarList.

Para enviar notificações por e-mail aos participantes de eventos inseridos ou atualizados com a API, chame o insert ou update método e defina o sendUpdates parâmetro como "all" ou "externalOnly".

Mecanismos de entrega

Os métodos de entrega oferecidos pelo Google Agenda são:

  • Pop-up. Eles são compatíveis com plataformas móveis e clientes da Web.
  • E-mail enviado pelo servidor.

A tabela a seguir mostra os métodos compatíveis com cada tipo de lembrete ou notificação:

Pop-up E-mail
Lembretes Lembretes padrão ✓ ✓
Substituir lembretes ✓ ✓
Notificações Criação do evento ❌ ✓
Mudança no evento ❌ ✓
Cancelamento de eventos ❌ ✓
Resposta do convidado ❌ ✓
Agenda ❌ ✓