Class GroupsApp

GroupsApp

לכיתה הזו יש גישה למידע על קבוצות Google. אפשר להשתמש בו כדי להריץ שאילתות על מידע כמו כתובת האימייל של קבוצה, או על רשימת הקבוצות שבהן המשתמש חבר ישיר.

הדוגמה הבאה מראה בכמה קבוצות חבר המשתמש הנוכחי:

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), נרשמת בעקיפין לקבוצה א'. למרות שקיבלתם עותקים של הודעות שנשלחו לקבוצה 'הורים', אתם לא מנויים לקבוצה הזו.

בעזרת Group.getRole(email) תוכלו לקבוע אם אתם חברים קיימים או בהמתנה בקבוצות שהוחזרו.

החזרות

Group[] – רשימת הקבוצות שהמשתמש חבר בהן ישירות.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

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