Class PhoneField

PhoneField

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

Champ de numéro de téléphone dans un contact.

Méthodes

Méthode	Type renvoyé	Brève description
getLabel()	Object	Récupère le libellé de ce champ.
isPrimary()	Boolean	Détermine s'il s'agit de la valeur du champ principal.
setAsPrimary()	PhoneField	Définit ce champ sur "Principal".
setLabel(field)	PhoneField	Définit le libellé de ce champ.
setLabel(label)	PhoneField	Définit le libellé de ce champ.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
deletePhoneField()	void	Supprime ce champ de numéro de téléphone.
getPhoneNumber()	String	Permet d'obtenir le numéro de téléphone de ce champ.
setPhoneNumber(number)	PhoneField	Définit le numéro de téléphone pour ce champ.

Documentation détaillée

getLabel()

Récupère le libellé de ce champ. Il peut s'agir d'un champ, d'un champ ExtendedField 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 associée à 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 : indique s'il s'agit de la version principale

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

---

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

PhoneField : cette valeur FieldValue pour le chaînage

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

---

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

PhoneField : cette valeur FieldValue pour le chaînage

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

---

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

PhoneField : champ utile pour les chaînes

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

Méthodes obsolètes

deletePhoneField()

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

Supprime ce champ de numéro de téléphone.

// Retrieves and deletes the work phone number field for contact 'John
// Doe'
var contacts = ContactsApp.getContactsByName('John Doe');
var phoneFields = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE);
phoneFields[0].deletePhoneField();

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

---

getPhoneNumber()

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

Permet d'obtenir le numéro de téléphone de ce champ.

// Logs the work phone number for contact 'John Doe'
var contacts = ContactsApp.getContactsByName('John Doe');
var phoneFields = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE);
Logger.log(phoneFields[0].getPhoneNumber());

Renvois

String : nombre sous forme de chaîne

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

---

setPhoneNumber(number)

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

Définit le numéro de téléphone pour ce champ.

// Sets the work phone number for contact 'John Doe'
var contacts = ContactsApp.getContactsByName('John Doe');
var phoneFields = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE);
phoneFields[0].setPhoneNumber('212-555-1234');

Paramètres

Nom	Type	Description
number	String	le nouveau numéro

Renvois

PhoneField : champ utile pour les chaînes

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