Lembretes e notificações

A API Calendar é compatível com lembretes e notificações.

  • Lembretes são alarmes acionados em um momento específico antes do início de um evento.
  • As notificações permitem que os usuários sejam informados sobre alterações nos eventos da agenda.

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

Veja mais detalhes sobre as notificações no Google Agenda em Modificar as notificações do Google Agenda.

Lembretes

Um lembrete consiste no seguinte:

  • Quando mostrar o lembrete, expresso em minutos antes do horário de início do evento
  • O método de exibição 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 agenda. Esses padrões se aplicam a todos os eventos da agenda. No entanto, os usuários também podem modificar 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. Como resultado:

  • Os lembretes padrão são manipulados por meio da coleção CalendarList, que contém metadados de agenda específicos do usuário
  • Eles não são acessíveis pela coleção Agendas, que contém metadados globais compartilhados entre todos os usuários.

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

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 de volta para true.

Notificações

O Google Agenda é compatível com os seguintes tipos de notificação:

  • Criação de evento: um novo evento é adicionado a uma das agendas do usuário.
  • Alteração no evento: o organizador modificou um evento para o qual o usuário foi convidado.
  • Cancelamento do evento: quando o usuário foi convidado, o evento é cancelado.
  • Resposta do participante: um participante de um evento criado pelo usuário alterou o próprio status de resposta.
  • Compromissos: 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. 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 sobre eventos que foram 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 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 de eventos ❌ ✓
Alteração no evento ❌ ✓
Cancelamento de eventos ❌ ✓
Resposta do participante ❌ ✓
Tópicos ❌ ✓