Class GroupsApp

GroupsApp

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

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

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

الخصائص

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

الطُرق

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

مستندات تفصيلية

getGroupByEmail(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.');
}

المَعلمات

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

الإرجاع

Group: المجموعة التي تتضمّن عنوان البريد الإلكتروني المحدّد

التفويض

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

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

getGroups()

تعرض هذه الطريقة جميع المجموعات التي أنت عضو مباشر فيها (أو عضو في انتظار الموافقة). ستكون هذه القائمة فارغة إذا لم تكن عضوًا في أي مجموعات. يطرح هذا الإجراء استثناءً إذا لم تكن المجموعة متوفّرة أو إذا لم يكن لديك إذن بالاطّلاع عليها.

في ما يلي مثال على كيفية طباعة عنوان البريد الإلكتروني لكل مجموعة ينتمي إليها المستخدم: 

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

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

الإرجاع

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

التفويض

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

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