Class GroupsApp

GroupsApp

Cette classe permet d'accéder aux informations de Google Groupes. Il peut être utilisé pour interroger des informations telles que comme 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. La fonction renvoie une exception si le groupe le fait. ou si vous n'avez pas l'autorisation de les consulter.

Voici un exemple qui récupère un groupe par son adresse e-mail et indique si la version actuelle utilisateur est membre. Avant de l'exécuter, remplacez l'exemple d'adresse e-mail par l'adresse e-mail d'un groupe réel.

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 dont l'adresse e-mail est spécifiée.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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). Il s'agit d'un liste vide si vous n'appartenez à aucun groupe. La fonction renvoie une exception si le groupe n'existe pas ou si vous n'êtes pas autorisé à la consulter.

L'exemple ci-dessous montre comment imprimer 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 d'un groupe B, qui est lui-même membre d'un autre groupe, A, alors vous êtes abonné indirectement au groupe A. Même si vous recevez des copies des messages envoyé au "parent" le groupe A, vous n’êtes pas réellement abonné à ce groupe.

Vous pouvez utiliser Group.getRole(email) pour déterminer si vous êtes un client existant ou en attente membre des groupes renvoyé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 correspondant à un ou plusieurs des champs d'application suivants:

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