Class GroupsApp

برنامه گروه ها

این کلاس دسترسی به اطلاعات Google Groups را فراهم می کند. می توان از آن برای پرس و جو کردن اطلاعاتی مانند آدرس ایمیل یک گروه یا لیست گروه هایی که کاربر در آنها عضو مستقیم است استفاده کرد.

در اینجا یک مثال است که نشان می دهد کاربر فعلی عضو چند گروه است:

const groups = GroupsApp.getGroups();
Logger.log(`You belong to ${groups.length} groups.`);

خواص

اموال تایپ کنید توضیحات
Role Role

روش ها

روش نوع برگشت شرح مختصر
get Group By Email(email) Group گروهی را با آدرس ایمیل مشخص شده بازیابی می کند.
get Groups() Group[] همه گروه هایی را که شما عضو مستقیم آنها هستید (یا عضو در حال انتظار) بازیابی می کند.

مستندات دقیق

get Group By Email(email)

گروهی را با آدرس ایمیل مشخص شده بازیابی می کند. اگر گروه وجود نداشته باشد یا اگر مجوز دیدن آن را نداشته باشید، یک استثنا می‌اندازد.

در اینجا یک مثال است که یک گروه را با آدرس ایمیل خود دریافت می کند و خروجی می دهد که آیا کاربر فعلی عضو است یا خیر. قبل از اجرا، آدرس ایمیل نمونه را با ایمیل یک گروه واقعی جایگزین کنید.

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  Logger.log('You are a member of this group.');
} else {
  Logger.log('You are not a member of this group.');
}

پارامترها

نام تایپ کنید توضیحات
email String آدرس ایمیل گروه برای بازیابی

بازگشت

Group - گروهی با آدرس ایمیل مشخص شده.

مجوز

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

  • https://www.googleapis.com/auth/groups

get Groups()

همه گروه هایی را که شما عضو مستقیم آنها هستید (یا عضو در حال انتظار) بازیابی می کند. اگر در هیچ گروهی نیستید، این یک لیست خالی است. اگر گروه وجود نداشته باشد یا اگر مجوز دیدن آن را نداشته باشید، یک استثنا می‌اندازد.

در اینجا مثالی از نحوه چاپ آدرس ایمیل برای هر گروهی که کاربر به آن تعلق دارد آورده شده است:

function showMyGroups() {
  const groups = GroupsApp.getGroups();
  let str = `You are in ${groups.length} groups: `;
  for (let i = 0; i < groups.length; i++) {
    const group = groups[i];
    str = `${str + group.getEmail()} `;
  }
  Logger.log(str);
}
توجه داشته باشید که اگر عضو یک گروه B هستید که خود عضو گروه دیگری A است، به طور غیرمستقیم مشترک گروه A هستید. حتی اگر کپی هایی از پیام های ارسال شده به گروه "والد" A را دریافت کنید. در واقع در آن گروه مشترک نیستند.

می‌توانید از Group.getRole(email) برای تعیین اینکه آیا عضو موجود یا معلق گروه‌های برگشتی هستید استفاده کنید.

بازگشت

Group[] - لیست گروه هایی که کاربر عضو مستقیم آنهاست.

مجوز

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

  • https://www.googleapis.com/auth/groups