Rappels et notifications

L'API Calendar prend en charge les rappels et les notifications.

  • Les rappels sont des alarmes déclenchées à une heure précise avant le début d'un événement.
  • Les notifications permettent aux utilisateurs d'être informés des modifications apportées aux événements de leur agenda.

Ce dernier élément ne doit pas être confondu avec les notifications push qui, au lieu d'être transmises à un utilisateur, informent un autre serveur des modifications apportées à un agenda.

Pour en savoir plus sur les notifications dans Google Agenda, consultez Modifier les notifications Google Agenda.

Rappels

Un rappel se compose des éléments suivants:

  • Quand afficher le rappel, exprimé en minutes avant l'heure de début de l'événement
  • Le mode de diffusion à utiliser (voir la section Mécanismes de diffusion)

Il est possible de définir des rappels pour des agendas entiers ou pour des événements individuels. Les utilisateurs peuvent définir des rappels par défaut pour chacun de leurs agendas. Ces rappels par défaut s'appliquent à tous les événements de cet agenda. Toutefois, les utilisateurs peuvent également remplacer ces valeurs par défaut pour des événements individuels, en les remplaçant par un autre ensemble de rappels.

Rappels par défaut

Les rappels sont des informations privées spécifiques à un utilisateur authentifié. Ils ne sont pas partagés entre plusieurs utilisateurs. En conséquence :

  • Les rappels par défaut sont manipulés via la collection "CalendarList", qui contient des métadonnées d'agenda spécifiques à l'utilisateur.
  • Ils ne sont pas accessibles via la collection Agendas, qui contient des métadonnées globales partagées entre tous les utilisateurs.

Des rappels par défaut sont également renvoyés lors de l'exécution d'une requête de liste d'événements.

Remplacer les rappels par défaut

Pour remplacer les rappels par défaut lorsque vous insérez ou modifiez un événement, définissez reminders.useDefault sur false et indiquez le nouveau rappel défini dans reminders.overrides.

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

Pour rétablir l'ensemble de rappels par défaut, redéfinissez le paramètre reminders.useDefault sur true.

Notifications

Agenda est compatible avec les types de notifications suivants:

  • Création d'un événement: un nouvel événement est ajouté à l'un des agendas de l'utilisateur.
  • Modification d'événement: l'organisateur a modifié un événement auquel l'utilisateur était invité.
  • Annulation de l'événement: un événement est annulé auquel l'utilisateur a été invité.
  • Réponse du participant: un participant à un événement créé par l'utilisateur a modifié l'état de sa réponse.
  • Agenda: liste de tous les événements de l'agenda de l'utilisateur, envoyés au début de la journée.

L'utilisateur peut choisir les notifications à activer pour chaque agenda et la méthode de diffusion pour chaque type de notification. Ces paramètres ne sont pas partagés avec les autres utilisateurs. Comme les rappels par défaut, ils sont accessibles via la collection CalendarList.

Pour envoyer des notifications par e-mail aux participants concernant des événements insérés ou mis à jour via l'API, définissez le paramètre sendNotifications de la requête d'insertion/de mise à jour sur "true".

Mécanismes de diffusion

Les modes d'envoi proposés par Google Agenda sont les suivants:

  • Pop-up : Ils sont pris en charge sur les plates-formes mobiles et les clients Web.
  • E-mail envoyé par le serveur.

Le tableau suivant présente les méthodes acceptées pour chaque type de rappel ou de notification:

Pop-up E-mail
Rappels Rappels par défaut
Ignorer les rappels
Notifications Création d'événements
Modification de l'événement
Annulation de l'événement
Réponse du participant
Sommaire