Class IMField

IMField

Устарело. Вместо этого используйте расширенный сервис People API.

Поле для обмена мгновенными сообщениями в Контакте.

Методы

Метод Тип возврата Краткое описание
get Address() String Получите адрес для этого поля.
get Label() Object Получает метку для этого поля.
is Primary() Boolean Проверяет, является ли это значение основным полем.
set Address(address) IMField Задает адрес этого поля.
set As Primary() IMField Устанавливает это поле как основное.
set Label(field) IMField Задает метку этого поля.
set Label(label) IMField Задает метку этого поля.
Метод Тип возврата Краткое описание
delete IMField() void Удаляет это поле мгновенного сообщения.

Подробная документация

get Address()

Получите адрес для этого поля.

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

Возвращаться

String — адрес в виде строки

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

get Label()

Получает метку для этого поля. Это может быть поле, расширенное поле или строка.

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

Возвращаться

Object — метка для этого поля

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

is Primary()

Проверяет, является ли это значение основным полем.

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

Возвращаться

Boolean — является ли оно первичным

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

set Address(address)

Задает адрес этого поля.

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

Параметры

Имя Тип Описание
address String новый адрес

Возвращаться

IMField — это поле, полезное для объединения в цепочку

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

set As Primary()

Устанавливает это поле как основное.

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

Возвращаться

IMField — это FieldValue для цепочки

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

set Label(field)

Задает метку этого поля.

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

Параметры

Имя Тип Описание
field Field новая стандартная этикетка

Возвращаться

IMField — это FieldValue для цепочки

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

set Label(label)

Задает метку этого поля.

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

Параметры

Имя Тип Описание
label String новый ярлык для этого поля

Возвращаться

IMField — это поле, полезное для объединения в цепочку

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

Устаревшие методы

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Удаляет это поле мгновенного сообщения.

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

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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