تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

Class Group

عنصر مجموعة يمكن الاستعلام عنه من قِبل أعضائه وأدوار هؤلاء الأعضاء داخل المجموعة.

إليك مثال يوضح أعضاء مجموعة. قبل تشغيلها، استبدل عنوان البريد الإلكتروني للمجموعة بعنوان البريد الإلكتروني على نطاقك.

function listGroupMembers() {
  var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
  console.log(group.getEmail() + ':');
  var users = group.getUsers();
  for (var i = 0; i < users.length; i++) {
    var user = users[i];
    console.log(user.getEmail());
  }
}

الطُرق

الطريقة	نوع القيمة التي يتم إرجاعها	وصف قصير
`getEmail()`	`String`	الحصول على عنوان البريد الإلكتروني لهذه المجموعة.
`getGroups()`	`Group[]`	استرداد المجموعات الفرعية المباشرة للمجموعة.
`getRole(email)`	`Role`	لاسترداد دور المستخدم في سياق المجموعة.
`getRole(user)`	`Role`	لاسترداد دور المستخدم في سياق المجموعة.
`getRoles(users)`	`Role[]`	لاسترداد أدوار المستخدمين في سياق المجموعة.
`getUsers()`	`User[]`	تتيح هذه الميزة الحصول على الأعضاء المباشرين في المجموعة الذين لديهم حساب Google مطابق معروف.
`hasGroup(group)`	`Boolean`	لاختبار ما إذا كانت المجموعة عضوًا مباشرًا في هذه المجموعة.
`hasGroup(email)`	`Boolean`	لاختبار ما إذا كانت المجموعة عضوًا مباشرًا في هذه المجموعة.
`hasUser(email)`	`Boolean`	لاختبار ما إذا كان المستخدم عضوًا مباشرًا في المجموعة.
`hasUser(user)`	`Boolean`	لاختبار ما إذا كان المستخدم عضوًا مباشرًا في المجموعة.

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

`getEmail()`

الحصول على عنوان البريد الإلكتروني لهذه المجموعة.

يسرد هذا المثال عنوان البريد الإلكتروني لجميع المجموعات التي ينتمي إليها المستخدم.

function listMyGroupEmails() {
  var groups = GroupsApp.getGroups();
  for (var i = 0; i < groups.length; i++) {
    console.log(groups[i].getEmail());
  }
}

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

String — عنوان البريد الإلكتروني للمجموعة.

التفويض

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

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

`getGroups()`

استرداد المجموعات الفرعية المباشرة للمجموعة. يضع استثناءً إذا لم يكن لديك إذن لعرض قائمة أعضاء المجموعة.

بالإضافة إلى هذه الطريقة، يمكنك استخدام خدمة دليل SDK للمشرف المتقدمة لاسترداد أعضاء المجموعة في نطاق.

function listGroupMembers() {
  var GROUP_EMAIL = "example@googlegroups.com";
  var group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  var childGroups = group.getGroups();
  console.log("Group " + GROUP_EMAIL + " has " + childGroups.length + " groups:");
  for (var i = 0; i < childGroups.length; i++) {
    var childGroup = childGroups[i];
    console.log(childGroup.getEmail());
  }
}

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

Group[]: جميع المجموعات الفرعية المباشرة للمجموعة

التفويض

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

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

`getRole(email)`

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

يسرد هذا المثال مالكي مجموعة:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var users = group.getUsers();
console.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  var user = users[i];
  if (group.getRole(user.getEmail()) == GroupsApp.Role.OWNER) {
    console.log(user.getEmail());
  }
}

المَعلمات

الاسم	Type	الوصف
`email`	`String`	عنوان البريد الإلكتروني للمستخدم.

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

Role: دور هذا المستخدم داخل المجموعة

التفويض

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

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

`getRole(user)`

يسرد هذا المثال مالكي مجموعة:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var users = group.getUsers();
console.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  var user = users[i];
  if (group.getRole(user) == GroupsApp.Role.OWNER) {
    console.log(user.getEmail());
  }
}

المَعلمات

الاسم	Type	الوصف
`user`	`User`	المستخدم المطلوب استرداد دوره.

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

Role: دور هذا المستخدم داخل المجموعة

التفويض

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

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

يمكن أيضًا مراجعة

getRole(email)

`getRoles(users)`

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

يسرد هذا المثال مالكي مجموعة:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var users = group.getUsers();
var roles = group.getRoles(users);
console.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  if (roles[i] == GroupsApp.Role.OWNER) {
    console.log(users[i].getEmail());
  }
}

المَعلمات

الاسم	Type	الوصف
`users`	`User[]`	المستخدمون الذين تم طلب أدوارهم

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

Role[] — أدوار هؤلاء المستخدمين داخل المجموعة

التفويض

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

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

`getUsers()`

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

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

function listGroupMembers() {
  var GROUP_EMAIL = "example@googlegroups.com";
  var group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  var users = group.getUsers();
  console.log("Group " + GROUP_EMAIL + " has " + users.length + " members:");
  for (var i = 0; i < users.length; i++) {
    var user = users[i];
    console.log(user.getEmail());
  }
}

بالإضافة إلى هذه الطريقة، يمكنك استخدام خدمة دليل SDK للمشرف المتقدمة لاسترداد أعضاء المجموعة في نطاق.

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

User[] - جميع الأعضاء المباشرين في المجموعة

التفويض

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

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

`hasGroup(group)`

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

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var childGroup = GroupsApp.getGroupByEmail("childgroup@googlegroups.com");
if (group.hasGroup(childGroup)) {
  console.log("childgroup@googlegroups.com is a child group");
}

المَعلمات

الاسم	Type	الوصف
`group`	`Group`	المجموعة المطلوب اختبار عضويتها.

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

Boolean: true إذا كانت هذه المجموعة مجموعة فرعية لها، وfalse في الحالات الأخرى.

التفويض

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

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

`hasGroup(email)`

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
if (group.hasGroup("childgroup@googlegroups.com")) {
  console.log("childgroup@googlegroups.com is a child group");
}

المَعلمات

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

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

Boolean: true إذا كانت هذه المجموعة مجموعة فرعية لها، وfalse في الحالات الأخرى.

التفويض

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

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

`hasUser(email)`

لاختبار ما إذا كان المستخدم عضوًا مباشرًا في المجموعة. يضع استثناءً إذا لم يكن لديك إذن لعرض قائمة أعضاء المجموعة.

إليك مثال للتحقق مما إذا كان المستخدم الحالي عضوًا في مجموعة:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser.getEmail())) {
  console.log("You are a member");
}

المَعلمات

الاسم	Type	الوصف
`email`	`String`	عنوان البريد الإلكتروني للمستخدم.

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

Boolean - true إذا كان هذا المستخدم عضوًا في المجموعة، وfalse في الحالات الأخرى.

التفويض

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

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

`hasUser(user)`

إليك مثال للتحقق مما إذا كان المستخدم الحالي عضوًا في مجموعة:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  console.log("You are a member");
}

المَعلمات

الاسم	Type	الوصف
`user`	`User`	المستخدم الذي يتم اختبار عضويته.

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

Boolean - true إذا كان هذا المستخدم عضوًا في المجموعة، وfalse في الحالات الأخرى.

التفويض

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

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