Class GroupsApp

GroupsApp

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

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

var groups = GroupsApp.getGroups();
Logger.log('You belong to ' + groups.length + ' groups.');

خواص

ویژگی	تایپ کنید	شرح
Role	Role

مواد و روش ها

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

مستندات دقیق

getGroupByEmail(email)

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

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

var group = GroupsApp.getGroupByEmail("[e-mail]");
var 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

---

getGroups()

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

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

function showMyGroups() {
  var groups = GroupsApp.getGroups();
  var str = 'You are in ' + groups.length + ' groups: ';
  for (var i = 0; i < groups.length; i++) {
    var group = groups[i];
    str = str + group.getEmail() + ' ';
  }
  Logger.log(str);
}

توجه داشته باشید که اگر عضو گروهی هستید، B، که خود عضو گروه دیگری، A است، به طور غیرمستقیم مشترک گروه A هستید. حتی اگر کپی هایی از پیام های ارسال شده به گروه "والد" را دریافت کنید. پاسخ، شما در واقع مشترک آن گروه نیستید.

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

برگشت

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

مجوز

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

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