Class GroupsApp

GroupsApp

يوفّر هذا الصف إمكانية الوصول إلى معلومات "مجموعات Google". يمكن استخدامها للاستعلام عن معلومات مثل عنوان البريد الإلكتروني للمجموعة، أو قائمة المجموعات التي يكون المستخدم عضوًا مباشرًا فيها.

إليك مثال يوضح عدد المجموعات التي ينتمي إليها المستخدم الحالي:

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

أماكن إقامة

الموقعTypeالوصف
RoleRole

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
getGroupByEmail(email)Groupلاسترداد المجموعة التي تحتوي على عنوان البريد الإلكتروني المحدد.
getGroups()Group[]استرداد جميع المجموعات التي تكون عضوًا مباشرًا فيها (أو عضوًا معلقًا فيها).

الوثائق التفصيلية

getGroupByEmail(email)

لاسترداد المجموعة التي تحتوي على عنوان البريد الإلكتروني المحدد. تطرح استثناء إذا لم تكن المجموعة موجودة أو إذا لم يكن لديك إذن لرؤيتها.

في ما يلي مثال يحصل على مجموعة حسب عنوان البريد الإلكتروني ويخرج ما إذا كان المستخدم الحالي عضوًا. قبل البدء، استبدِل نموذج عنوان البريد الإلكتروني بعنوان بريد إلكتروني لمجموعة حقيقية.

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
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.");
}

المَعلمات

الاسمTypeالوصف
emailStringعنوان البريد الإلكتروني للمجموعة المراد استردادها.

استرجاع الكرة

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);
}
ملاحظة: إذا كنت عضوًا في المجموعة "ب" وهي في حد ذاتها عضو في المجموعة "أ"، يعني ذلك أنّك اشتركت بشكل غير مباشر في المجموعة "أ". على الرغم من تلقي نسخ من الرسائل المرسلة إلى المجموعة "الأصلية" أ، فأنت غير مشترك في تلك المجموعة فعليًا.

يمكنك استخدام Group.getRole(email) لتحديد ما إذا كنت عضوًا حاليًا أو في انتظار المراجعة في المجموعات التي تم إرجاعها.

استرجاع الكرة

Group[] - قائمة المجموعات التي يكون المستخدم عضوًا مباشرًا فيها

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

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