Class IMField

IMField

Obsolète. Utilisez plutôt l'API People d'assistance

Champ de messagerie instantanée dans un contact.

Méthodes

Méthode	Type renvoyé	Brève description
getAddress()	String	Permet d'obtenir l'adresse de ce champ.
getLabel()	Object	Récupère le libellé de ce champ.
isPrimary()	Boolean	Détermine s'il s'agit de la valeur du champ principal.
setAddress(address)	IMField	Définit l'adresse de ce champ.
setAsPrimary()	IMField	Définit ce champ sur principal.
setLabel(field)	IMField	Définit le libellé de ce champ.
setLabel(label)	IMField	Définit le libellé de ce champ.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
deleteIMField()	void	Supprime ce champ de messagerie instantanée.

Documentation détaillée

getAddress()

Permet d'obtenir l'adresse de ce champ.

// Logs the address for the 'Home Address' field for contact 'John Doe'.
// Can be used similarly for other fields that contain addresses.
var contacts = ContactsApp.getContactsByName('John Doe');
var homeAddress = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);
Logger.log(homeAddress[0].getAddress());

Renvois

String : adresse sous forme de chaîne

Autorisation

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

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

---

getLabel()

Récupère le libellé de ce champ. Il peut s'agir d'un champ, d'un champ étendu ou d'une chaîne.

// Logs the label for all the address fields associated with contact
// 'John Doe'. This method can be similarly called for any field that has
// a label.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
for (var i = 0; i < addressFields.length; i++) {
  Logger.log(addressFields[i].getLabel());
}

Renvois

Object : libellé de ce champ

Autorisation

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

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

---

isPrimary()

Détermine s'il s'agit de la valeur du champ principal.

// Logs whether or not the first address field associated with contact
// 'John Doe' is labeled as primary. This method can be similarly called
// for any field.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
Logger.log(addressFields[0].isPrimary());

Renvois

Boolean : s'il s'agit de l'instance principale

Autorisation

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

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

---

setAddress(address)

Définit l'adresse de ce champ.

// Sets the address for the 'Home Address' field for contact 'John Doe'.
// Can be used similarly for other fields that contain addresses.
var contacts = ContactsApp.getContactsByName('John Doe');
var homeAddress = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);
homeAddress[0].setAddress('123 Main St, Raleigh, NC, 27601');

Paramètres

Nom	Type	Description
address	String	la nouvelle adresse

Renvois

IMField : champ utile pour les enchaînements

Autorisation

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

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

---

setAsPrimary()

Définit ce champ sur principal.

// Sets the the first address field associated with contact 'John Doe'
// as primary. This method can be similarly called for any field.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
addressFields[0].setAsPrimary();

Renvois

IMField : cette valeur FieldValue pour le chaînage

Autorisation

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

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

---

setLabel(field)

Définit le libellé de ce champ.

// Sets the label to 'Work' for the first address field associated
// with contact 'John Doe'. This method can be similarly called for any
// field that has a label.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
addressFields[0].setLabel(ContactsApp.Field.WORK_ADDRESS);

Paramètres

Nom	Type	Description
field	Field	le nouveau libellé standard

Renvois

IMField : cette valeur FieldValue pour le chaînage

Autorisation

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

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

---

setLabel(label)

Définit le libellé de ce champ.

// Sets the label to 'Apartment' for the first address field associated
// with contact 'John Doe'. This method can be similarly called for any
// field that has a label.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
addressFields[0].setLabel('Apartment');

Paramètres

Nom	Type	Description
label	String	le nouveau libellé de ce champ

Renvois

IMField : champ utile pour les enchaînements

Autorisation

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

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

Méthodes obsolètes

deleteIMField()

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

Supprime ce champ de messagerie instantanée.

// Retrieves and deletes the AIM instant messaging field for contact 'John
// Doe'
var contacts = ContactsApp.getContactsByName('John Doe');
var imFields = contacts[0].getIMs(ContactsApp.Field.AIM);
imFields[0].deleteIMField();

Autorisation

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

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