Class GroupsApp

GroupsApp

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

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

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

أماكن إقامة

الموقعالنوعالوصف
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.");
}

المعلمات

الاسمالنوعالوصف
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