Lembretes e notificações

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

  • Lembretes são alarmes acionados em um horário especificado antes do início de um evento.
  • Com a opção Notificações, os usuários podem ficar sabendo das alterações nos eventos da agenda.

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

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 exibição a ser usado (consulte Mecanismos de exibição)

Lembretes podem ser especificados para agendas inteiras e para 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 substituir esses padrões por eventos específicos, 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 e 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.

Lembretes padrão também são retornados ao fazer uma consulta da 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 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 do evento: o organizador modificou um evento para o qual o usuário foi convidado.
  • Cancelamento de evento: um evento é cancelado para o qual o usuário foi convidado.
  • Resposta do participante: um convidado de um evento criado pelo usuário alterou o status de resposta.
  • Compromissos: uma lista de todos os eventos na agenda do usuário, enviados no início do dia.

O usuário pode decidir quais notificações ativar de acordo com a agenda e o método de entrega de 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 sobre eventos que foram inseridos ou atualizados pela API, defina o parâmetro sendNotifications na solicitação de inserção/atualização como verdadeiro.

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 para cada lembrete ou tipo de notificação:

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