Class ContactGroup

گروه تماس

منسوخ شده است. در عوض، از سرویس پیشرفته People API استفاده کنید

گروه تماس گروهی از مخاطبین است.

روش نوع برگشت شرح مختصر
addContact(contact) ContactGroup مخاطب داده شده را به این گروه اضافه می کند
deleteGroup() void این گروه تماس را حذف می کند.
getContacts() Contact[] تمام مخاطبین این گروه تماس را دریافت می کند.
getGroupName() String نام این گروه را برمی گرداند.
getId() String شناسه این گروه تماس را دریافت می کند.
getName() String نام این گروه تماس را دریافت می کند.
isSystemGroup() Boolean برای تعیین اینکه آیا این گروه مخاطب یک گروه سیستمی (غیرقابل حذف) است یا خیر، یک مقدار بولی دریافت می کند.
removeContact(contact) ContactGroup مخاطب داده شده را از این گروه حذف می کند
setGroupName(name) void نام این گروه را تنظیم می کند.
setName(name) ContactGroup نام این گروه تماس را تنظیم می کند.

روش های منسوخ شده

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

مخاطب داده شده را به این گروه اضافه می کند

// The code below creates a new contact and adds it to the "Work Friends" contact group
var contact = ContactsApp.createContact('John', 'Doe', 'john.doe@example.com');
var group = ContactsApp.getContactGroup('Work Friends');
group.addContact(contact);

پارامترها

نام تایپ کنید توضیحات
contact Contact مخاطبی که باید به گروه اضافه شود

بازگشت

ContactGroup - این گروه تماس

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

این گروه تماس را حذف می کند.

فقط گروه های غیر سیستمی را حذف می کند. گروه های سیستم را نمی توان حذف کرد.

// The code below retrieves a contact group named "Work Friends" and deletes it
var group = ContactsApp.getContactGroup('Work Friends');
group.deleteGroup();

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

تمام مخاطبین این گروه تماس را دریافت می کند.

// The code below retrieves all the contacts in the group named "Work Friends"
var group = ContactsApp.getContactGroup('Work Friends');
var contacts = group.getContacts();

بازگشت

Contact[] — مخاطبین این گروه

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

نام این گروه را برمی گرداند.

بازگشت

String - نام این گروه

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

شناسه این گروه تماس را دریافت می کند.

// The code below retrieves a contact group named "Work Friends" and gets its id
var group = ContactsApp.getContactGroup('Work Friends');
var id = group.getId();

بازگشت

String - شناسه این گروه

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

نام این گروه تماس را دریافت می کند.

// The code below creates a new contact group and then retrieves its name
var group = ContactsApp.createContactGroup('Work Friends');
var name = group.getName();

بازگشت

String - این نام این گروه تماس است

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

برای تعیین اینکه آیا این گروه مخاطب یک گروه سیستمی (غیرقابل حذف) است یا خیر، یک مقدار بولی دریافت می کند.

گروه‌های سیستمی مجموعه‌ای از گروه‌هایی هستند که در Google Contacts از پیش تعریف شده‌اند، مانند «مخاطبین من»، «خانواده»، «همکاران» و غیره. نام یک گروه سیستم معمولاً حاوی کلمات «گروه سیستم» است.

// The code below retrieves two contact groups, then logs whether or not
// each is a system group.
var myGroup = ContactsApp.getContactGroup('Work Friends');
var systemGroup = ContactsApp.getContactGroup('System Group: Coworkers');
Logger.log(myGroup.isSystemGroup()); // Returns false, if the group exists.
Logger.log(systemGroup.isSystemGroup()); // Returns true.

بازگشت

Boolean - آیا این گروه تماس یک گروه سیستمی است یا خیر

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

مخاطب داده شده را از این گروه حذف می کند

// The code below retrieves all the contacts named "John Doe' and removes them from the
// "Work Friends" contact group
var contacts = ContactsApp.getContactsByName('John Doe');
var group = ContactsApp.getContactGroup('Work Friends');
for (var i in contacts) {
  group.removeContact(contacts[i]);
}

پارامترها

نام تایپ کنید توضیحات
contact Contact مخاطبی که باید از گروه حذف شود

بازگشت

ContactGroup - این گروه تماس

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

نام این گروه را تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
name String نامی که باید برای این گروه تعیین کنید

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

نام این گروه تماس را تنظیم می کند.

// The code below retrieves the contact group named "Work Friends" and renames it to
// "Work Buddies"
var group = ContactsApp.getContactGroup('Work Friends');
group.setName('Work Buddies');

پارامترها

نام تایپ کنید توضیحات
name String نام جدید برای گروه تماس

بازگشت

ContactGroup - این گروه تماس

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید