Class IMField

IMField

Obsoleto. En su lugar, usa el servicio avanzado de la API de People.

Un campo de mensajería instantánea en un contacto.

Métodos

MétodoTipo de datos que se muestraDescripción breve
getAddress()StringObtén la dirección de este campo.
getLabel()ObjectObtiene la etiqueta de este campo.
isPrimary()BooleanObtiene si este es el valor del campo principal.
setAddress(address)IMFieldEstablece la dirección de este campo.
setAsPrimary()IMFieldEstablece este campo como primario.
setLabel(field)IMFieldEstablece la etiqueta de este campo.
setLabel(label)IMFieldEstablece la etiqueta de este campo.
MétodoTipo de datos que se muestraDescripción breve
deleteIMField()voidBorra este campo de mensajería instantánea.

Documentación detallada

getAddress()

Obtén la dirección de este campo.

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

Volver

String: Es la dirección como una cadena.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getLabel()

Obtiene la etiqueta de este campo. Puede ser un campo, un ExtendedField o una cadena.

// 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const addressFields = contacts[0].getAddresses();
for (let i = 0; i < addressFields.length; i++) {
 
Logger.log(addressFields[i].getLabel());
}

Volver

Object: Es la etiqueta de este campo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

isPrimary()

Obtiene si este es el valor del campo 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const addressFields = contacts[0].getAddresses();
Logger.log(addressFields[0].isPrimary());

Volver

Boolean: Indica si es el elemento principal.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setAddress(address)

Establece la dirección de este campo.

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

Parámetros

NombreTipoDescripción
addressStringla dirección nueva

Volver

IMField: Este campo es útil para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setAsPrimary()

Establece este campo como primario.

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

Volver

IMField: Este FieldValue para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setLabel(field)

Establece la etiqueta de este campo.

// 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const addressFields = contacts[0].getAddresses();
addressFields
[0].setLabel(ContactsApp.Field.WORK_ADDRESS);

Parámetros

NombreTipoDescripción
fieldFieldla nueva etiqueta estándar

Volver

IMField: Este FieldValue para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setLabel(label)

Establece la etiqueta de este campo.

// 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const addressFields = contacts[0].getAddresses();
addressFields
[0].setLabel('Apartment');

Parámetros

NombreTipoDescripción
labelStringla nueva etiqueta para este campo

Volver

IMField: Este campo es útil para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

Métodos obsoletos

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Borra este campo de mensajería instantánea.

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

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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