Rappels et notifications

L'API Calendar est compatible avec les rappels et les notifications.

• Les rappels sont des alarmes qui se déclenchent à une heure spécifiée avant le début d'un événement.
• Les notifications permettent aux utilisateurs de se tenir informés des modifications apportées aux événements de leur agenda.

Ces notifications ne doivent pas être confondues avec les push notifications qui, au lieu d'être envoyées à 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 :

• Le moment où le rappel doit s'afficher, exprimé en minutes avant l'heure de début de l'événement
• Le mode de diffusion à utiliser (voir Mécanismes de diffusion)

Les rappels peuvent être spécifiés pour des agendas entiers et pour des événements individuels. Les utilisateurs peuvent définir des rappels par défaut pour chacun de leurs agendas. Ces paramètres par défaut s'appliquent à tous les événements de cet agenda. Toutefois, les utilisateurs peuvent également remplacer ces paramètres 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. Par conséquent :

• 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 Calendars, qui contient des métadonnées globales partagées entre tous les utilisateurs.

Les rappels par défaut sont également renvoyés lors 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 remplissez reminders.overrides avec le nouvel ensemble de rappels.

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

Pour revenir à l'ensemble de rappels par défaut, effectuez une mise à jour en définissant reminders.useDefault sur true.

Notifications

Agenda est compatible avec les types de notifications suivants :

• Création d'é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 a été invité.
• Annulation d'événement : un événement auquel l'utilisateur a été invité est annulé.
• Réponse d'un participant : un participant à un événement créé par l'utilisateur a modifié son statut de réponse.
• Sommaire : liste de tous les événements de l'agenda de l'utilisateur, envoyée au début de la journée.

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

Pour envoyer des notifications par e-mail aux participants pour les événements insérés ou mis à jour avec l'API, appelez la insert ou update méthode et définissez le sendUpdates paramètre sur "all" ou "externalOnly".

Mécanismes de diffusion

Les modes de diffusion proposés par Google Agenda sont les suivants :

• Pop-up. Ils sont compatibles avec les plates-formes mobiles et les clients Web.
• E-mail envoyé par le serveur.

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