Cette page a été traduite par l'API Cloud Translation.

Class ContactGroup

Obsolète. Utilisez plutôt le service avancé de l'API People.

Un ContactGroup est un groupe de contacts.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`addContact(contact)`	`ContactGroup`	Ajoute le contact indiqué à ce groupe
`deleteGroup()`	`void`	Supprime ce groupe de contacts.
`getContacts()`	`Contact[]`	Récupère tous les contacts de ce groupe de contacts.
`getGroupName()`	`String`	Renvoie le nom de ce groupe.
`getId()`	`String`	Récupère l'ID de ce groupe de contacts.
`getName()`	`String`	Récupère le nom de ce groupe de contacts.
`isSystemGroup()`	`Boolean`	Récupère une valeur booléenne pour déterminer si ce groupe de contacts est un groupe système (non suppressible).
`removeContact(contact)`	`ContactGroup`	Supprime le contact indiqué de ce groupe
`setGroupName(name)`	`void`	Définit le nom de ce groupe.
`setName(name)`	`ContactGroup`	Définit le nom de ce groupe de contacts.

Méthodes obsolètes

`addContact(contact)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Ajoute le contact indiqué à ce groupe

// The code below creates a new contact and adds it to the "Work Friends" contact group
var contact = ContactsApp.createContact('John', 'Doe', 'john.doe@example.com');
var group = ContactsApp.getContactGroup('Work Friends');
group.addContact(contact);

Paramètres

Nom	Type	Description
`contact`	`Contact`	le contact à ajouter au groupe

Renvois

ContactGroup — ce groupe de contacts

Autorisation

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

https://www.google.com/m8/feeds

Voir aussi

removeContact(contact)

`deleteGroup()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Supprime ce groupe de contacts.

Supprime uniquement les groupes hors système ; les groupes système ne peuvent pas être supprimés.

// The code below retrieves a contact group named "Work Friends" and deletes it
var group = ContactsApp.getContactGroup('Work Friends');
group.deleteGroup();

Autorisation

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

https://www.google.com/m8/feeds

Voir aussi

isSystemGroup()

`getContacts()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Récupère tous les contacts de ce groupe de contacts.

// The code below retrieves all the contacts in the group named "Work Friends"
var group = ContactsApp.getContactGroup('Work Friends');
var contacts = group.getContacts();

Renvois

Contact[] : contacts figurant dans ce groupe

Autorisation

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

https://www.google.com/m8/feeds

`getGroupName()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Renvoie le nom de ce groupe.

Renvois

String : nom de ce groupe

Autorisation

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

https://www.google.com/m8/feeds

`getId()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Récupère l'ID de ce groupe de contacts.

// The code below retrieves a contact group named "Work Friends" and gets its id
var group = ContactsApp.getContactGroup('Work Friends');
var id = group.getId();

Renvois

String : identifiant de ce groupe

Autorisation

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

https://www.google.com/m8/feeds

`getName()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Récupère le nom de ce groupe de contacts.

// The code below creates a new contact group and then retrieves its name
var group = ContactsApp.createContactGroup('Work Friends');
var name = group.getName();

Renvois

String : nom de ce groupe de contacts

Autorisation

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

https://www.google.com/m8/feeds

Voir aussi

setName(name)

`isSystemGroup()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Récupère une valeur booléenne pour déterminer si ce groupe de contacts est un groupe système (non suppressible).

Les groupes système sont un ensemble de groupes prédéfinis dans Google Contacts, tels que "Mes contacts", "Famille", "Collègues", etc. Le nom d'un groupe système contient généralement les mots "Groupe système".

// The code below retrieves two contact groups, then logs whether or not
// each is a system group.
var myGroup = ContactsApp.getContactGroup('Work Friends');
var systemGroup = ContactsApp.getContactGroup('System Group: Coworkers');
Logger.log(myGroup.isSystemGroup()); // Returns false, if the group exists.
Logger.log(systemGroup.isSystemGroup()); // Returns true.

Renvois

Boolean : indique si ce groupe de contacts est un groupe système ou non

Autorisation

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

https://www.google.com/m8/feeds

`removeContact(contact)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Supprime le contact indiqué de ce groupe

// The code below retrieves all the contacts named "John Doe' and removes them from the
// "Work Friends" contact group
var contacts = ContactsApp.getContactsByName('John Doe');
var group = ContactsApp.getContactGroup('Work Friends');
for (var i in contacts) {
  group.removeContact(contacts[i]);
}

Paramètres

Nom	Type	Description
`contact`	`Contact`	le contact à retirer du groupe

Renvois

ContactGroup — ce groupe de contacts

Autorisation

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

https://www.google.com/m8/feeds

Voir aussi

addContact(contact)

`setGroupName(name)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Définit le nom de ce groupe.

Paramètres

Nom	Type	Description
`name`	`String`	le nom à définir pour ce groupe ;

Autorisation

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

https://www.google.com/m8/feeds

`setName(name)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Définit le nom de ce groupe de contacts.

// The code below retrieves the contact group named "Work Friends" and renames it to
// "Work Buddies"
var group = ContactsApp.getContactGroup('Work Friends');
group.setName('Work Buddies');

Paramètres

Nom	Type	Description
`name`	`String`	le nouveau nom du groupe de contacts ;

Renvois

ContactGroup — ce groupe de contacts

Autorisation

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

https://www.google.com/m8/feeds

Voir aussi

getName()