Class IMField

IMField

Obsoleto. Em vez disso, use o serviço avançado da API People.

Um campo de mensagens instantâneas em um contato.

Métodos

Método	Tipo de retorno	Breve descrição
getAddress()	String	Receba o endereço desse campo.
getLabel()	Object	Recebe o rótulo desse campo.
isPrimary()	Boolean	Verifica se esse é o valor do campo principal.
setAddress(address)	IMField	Define o endereço desse campo.
setAsPrimary()	IMField	Define esse campo como primário.
setLabel(field)	IMField	Define o rótulo desse campo.
setLabel(label)	IMField	Define o rótulo desse campo.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
deleteIMField()	void	Exclui este campo de mensagens instantâneas.

Documentação detalhada

getAddress()

Receba o endereço desse 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());

Retornar

String: o endereço como uma string

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

---

getLabel()

Recebe o rótulo desse campo. Pode ser um campo, um ExtendedField ou uma string.

// 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());
}

Retornar

Object: o rótulo do campo

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

---

isPrimary()

Verifica se esse é o valor do 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());

Retornar

Boolean: se é a principal

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

---

setAddress(address)

Define o endereço desse 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

Nome	Tipo	Descrição
address	String	o novo endereço

Retornar

IMField: este campo é útil para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

---

setAsPrimary()

Define esse campo como primário.

// 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();

Retornar

IMField: FieldValue para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

---

setLabel(field)

Define o rótulo desse 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

Nome	Tipo	Descrição
field	Field	o novo rótulo padrão

Retornar

IMField: FieldValue para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

---

setLabel(label)

Define o rótulo desse 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

Nome	Tipo	Descrição
label	String	o novo rótulo para esse campo

Retornar

IMField: este campo é útil para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Métodos obsoletos

deleteIMField()

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Exclui este campo de mensagens instantâneas.

// 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();

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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