Class GroupsApp

GroupsApp

Cette classe permet d'accéder aux informations de Google Groupes. Il permet d'interroger des informations telles que l'adresse e-mail d'un groupe ou la liste des groupes dont l'utilisateur est un membre direct.

Voici un exemple indiquant le nombre de groupes dont l'utilisateur actuel est membre:

var groups = GroupsApp.getGroups();
Logger.log('You belong to ' + groups.length + ' groups.');

Propriétés

Propriété	Type	Description
Role	Role

Méthodes

Méthode	Type renvoyé	Brève description
getGroupByEmail(email)	Group	Récupère le groupe associé à l'adresse e-mail spécifiée.
getGroups()	Group[]	Récupère tous les groupes dont vous êtes un membre direct (ou un membre en attente).

Documentation détaillée

getGroupByEmail(email)

Récupère le groupe associé à l'adresse e-mail spécifiée. Elle génère une exception si le groupe n'existe pas ou si vous n'êtes pas autorisé à le voir.

Voici un exemple qui récupère un groupe à l'aide de son adresse e-mail et indique si l'utilisateur actuel est membre. Avant l'exécution, remplacez l'exemple d'adresse e-mail par une adresse e-mail de groupe.

var group = GroupsApp.getGroupByEmail("[e-mail]");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  Logger.log("You are a member of this group.");
}
else {
  Logger.log("You are not a member of this group.");
}

Paramètres

Nom	Type	Description
email	String	Adresse e-mail du groupe à récupérer.

Renvois

Group : groupe associé à l'adresse e-mail spécifiée.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

• https://www.googleapis.com/auth/groups

---

getGroups()

Récupère tous les groupes dont vous êtes un membre direct (ou un membre en attente). Cette liste est vide si vous ne faites partie d'aucun groupe. Elle génère une exception si le groupe n'existe pas ou si vous n'êtes pas autorisé à le voir.

Voici un exemple d'impression de l'adresse e-mail de chaque groupe auquel l'utilisateur appartient:

function showMyGroups() {
  var groups = GroupsApp.getGroups();
  var str = 'You are in ' + groups.length + ' groups: ';
  for (var i = 0; i < groups.length; i++) {
    var group = groups[i];
    str = str + group.getEmail() + ' ';
  }
  Logger.log(str);
}

Notez que si vous êtes membre du groupe B, qui est lui-même membre d'un autre groupe A, vous êtes alors abonné indirectement au groupe A. Même si vous recevez des copies des messages envoyés au groupe "parent" A, vous n'êtes pas réellement abonné à ce groupe.

Vous pouvez utiliser Group.getRole(email) pour déterminer si vous êtes un membre existant ou en attente des groupes affichés.

Renvois

Group[] : liste des groupes dont l'utilisateur est un membre direct.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

• https://www.googleapis.com/auth/groups