Lembretes e notificações

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

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

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

Para mais detalhes sobre as notificações no Google Agenda, acesse 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 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 para 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.
  • Elas não podem ser acessadas na coleção Agendas, que contém metadados globais compartilhados por todos os usuários.

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

Como substituir lembretes padrão

Para substituir os lembretes padrão ao inserir ou modificar um evento, defina reminders.useDefault como false e preencha reminders.overrides com o novo lembrete definido.

"reminders": {
  "useDefault": false,
  # Overrides can be set if and only if useDefault is false.
  "overrides": [
      {
        "method": "reminderMethod",
        "minutes": "reminderMinutes"
      },
      # ...
  ]
}

Para reverter para o conjunto padrão de lembretes, execute uma configuração de atualização reminders.useDefault para true.

Notificações

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

  • Criação de evento: um novo evento é adicionado a uma das agendas do usuário.
  • Alteração de evento: o organizador modificou um evento para o qual o usuário foi convidado.
  • Cancelamento de evento: um evento para o qual o usuário foi convidado foi cancelado.
  • Resposta do participante: um participante de um evento criado pelo usuário mudou o status da resposta.
  • 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 envio para cada tipo de notificação. Essas configurações não são compartilhadas com outros usuários. Assim como os lembretes padrão, eles podem ser acessados pela coleção CalendarList.

Para enviar notificações por e-mail aos participantes de eventos inseridos ou atualizados pela API, defina o parâmetro sendNotifications na solicitação de inserção/atualização como "true".

Mecanismos de entrega

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

  • Pop-up. Eles têm suporte em plataformas móveis e em clientes da Web.
  • E-mail enviado pelo servidor.

A tabela a seguir mostra os métodos aceitos para cada tipo de lembrete ou notificação:

Pop-up E-mail
Lembretes Lembretes padrão ✓ ✓
Substituir lembretes ✓ ✓
Notificações Criação do evento ❌ ✓
Alteração no evento ❌ ✓
Cancelamento de eventos ❌ ✓
Resposta do participante ❌ ✓
Tópicos ❌ ✓