Class Grid

شبكة

شبكة منظمة لعرض مجموعة من عناصر الشبكة.

متاحة لإضافات Google Workspace وتطبيقات Google Chat.

var grid = CardService.newGrid()
    .setTitle("My Grid")
    .setNumColumns(2)
    .addItem(CardService.newGridItem()
        .setTitle("My item"));

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
addItem(gridItem)Gridلإضافة عنصر شبكة جديد إلى الشبكة.
setAuthorizationAction(action)Gridلضبط إجراء تفويض يفتح عنوان URL لمسار التفويض عند النقر على الكائن.
setBorderStyle(borderStyle)Gridلضبط نمط الحد المطبّق على كل عنصر في الشبكة.
setComposeAction(action, composedEmailType)Gridتعيين إجراء يؤدي إلى إنشاء مسودة رسالة إلكترونية عند النقر على الكائن.
setNumColumns(numColumns)Gridعدد الأعمدة المطلوب عرضها في الشبكة.
setOnClickAction(action)Gridتحدّد إجراءً يتم تنفيذه عند النقر على العنصر.
setOnClickOpenLinkAction(action)Gridتحدّد هذه السياسة إجراءً يؤدي إلى فتح عنوان URL في علامة تبويب عند النقر على العنصر.
setOpenLink(openLink)Gridلضبط عنوان URL ليتم فتحه عند النقر على العنصر.
setTitle(title)Gridتحدِّد هذه السياسة نص عنوان الشبكة.

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

addItem(gridItem)

لإضافة عنصر شبكة جديد إلى الشبكة.

المَعلمات

الاسمالنوعالوصف
gridItemGridItemعنصر الشبكة المطلوب إضافته.

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

Grid: هذا الكائن، للتسلسل.


setAuthorizationAction(action)

لضبط إجراء تفويض يفتح عنوان URL لمسار التفويض عند النقر على الكائن. يؤدي هذا الإجراء إلى فتح عنوان URL في نافذة جديدة. عندما ينهي المستخدم تدفق التفويض ويعود إلى التطبيق، تتم إعادة تحميل الإضافة.

يمكن أن يحتوي عنصر واجهة المستخدم على مجموعة واحدة فقط من setOpenLink(openLink) أو setOnClickAction(action) أو setOnClickOpenLinkAction(action) أو setAuthorizationAction(action) أو setComposeAction(action, composedEmailType).

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

المَعلمات

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

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

Grid: هذا الكائن، للتسلسل.


setBorderStyle(borderStyle)

لضبط نمط الحد المطبّق على كل عنصر في الشبكة. القيمة التلقائية هي NO_BORDER.

المَعلمات

الاسمالنوعالوصف
borderStyleBorderStyleنمط الحد المطلوب تطبيقه

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

Grid: هذا الكائن، للتسلسل.


setComposeAction(action, composedEmailType)

تعيين إجراء يؤدي إلى إنشاء مسودة رسالة إلكترونية عند النقر على الكائن. يمكن أن يحتوي كائن واجهة المستخدم على مجموعة واحدة فقط من setOpenLink(openLink) أو setOnClickAction(action) أو setOnClickOpenLinkAction(action) أو setAuthorizationAction(action) أو setComposeAction(action, composedEmailType).

يجب أن تحدد المعلَمة Action دالة استدعاء تعرض عنصر ComposeActionResponse تم ضبطه باستخدام ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

var action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

المَعلمات

الاسمالنوعالوصف
actionActionتمثّل هذه السمة الكائن الذي يحدد إجراء الإنشاء المطلوب اتخاذه عند النقر على هذا العنصر.
composedEmailTypeComposedEmailTypeهي قيمة تعداد تحدّد ما إذا كانت المسودة التي تم إنشاؤها هي مسودة مستقلة أو مسودة ردّ.

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

Grid: هذا الكائن، للتسلسل.


setNumColumns(numColumns)

عدد الأعمدة المطلوب عرضها في الشبكة. إذا تم عرضها في اللوحة الجانبية اليمنى، يمكنك عرض عمود أو عمودين والقيمة الافتراضية هي 1. إذا تم عرضها في مربع حوار، يمكنك عرض 2-3 أعمدة والقيمة الافتراضية هي 2.

المَعلمات

الاسمالنوعالوصف
numColumnsIntegerعدد الأعمدة.

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

Grid: هذا الكائن، للتسلسل.


setOnClickAction(action)

تحدّد إجراءً يتم تنفيذه عند النقر على العنصر. يمكن أن يحتوي عنصر واجهة المستخدم على مجموعة واحدة فقط من setOpenLink(openLink) أو setOnClickAction(action) أو setOnClickOpenLinkAction(action) أو setAuthorizationAction(action) أو setComposeAction(action, composedEmailType).

يجب أن تحدد المعلَمة Action دالة استدعاء تُرجع كائن ActionResponse.

// ...

var action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton().setText('Create notification').setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(CardService.newNotification()
          .setText("Some info to display to user"))
      .build();
}

المَعلمات

الاسمالنوعالوصف
actionActionالإجراء الذي يتم اتخاذه عند النقر على هذا العنصر.

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

Grid: هذا الكائن، للتسلسل.


setOnClickOpenLinkAction(action)

تحدّد هذه السياسة إجراءً يؤدي إلى فتح عنوان URL في علامة تبويب عند النقر على العنصر. استخدِم هذه الوظيفة عندما يكون من الضروري إنشاء عنوان URL أو عندما تحتاج إلى اتّخاذ إجراءات أخرى بالإضافة إلى إنشاء الكائن OpenLink. يمكن أن يحتوي عنصر واجهة المستخدم على مجموعة واحدة فقط من setOpenLink(openLink) أو setOnClickAction(action) أو setOnClickOpenLinkAction(action) أو setAuthorizationAction(action) أو setComposeAction(action, composedEmailType).

يجب أن تحدد المعلَمة Action دالة استدعاء تعرض عنصر ActionResponse تم ضبطه باستخدام ActionResponseBuilder.setOpenLink(openLink).

// ...

var action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton().setText('Open Link').setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink()
          .setUrl('https://www.google.com'))
      .build();
}

المَعلمات

الاسمالنوعالوصف
actionActionتمثّل هذه السمة الكائن الذي يحدّد إجراء "الرابط المفتوح" الذي سيتم اتخاذه عند النقر على هذا العنصر.

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

Grid: هذا الكائن، للتسلسل.


لضبط عنوان URL ليتم فتحه عند النقر على العنصر. استخدِم هذه الدالة عندما يكون عنوان URL معروفًا بالفعل ويحتاج إلى فتح فقط. يمكن أن يحتوي كائن واجهة المستخدم على مجموعة واحدة فقط من setOpenLink(openLink) أو setOnClickAction(action) أو setOnClickOpenLinkAction(action) أو setAuthorizationAction(action) أو setComposeAction(action, composedEmailType).

المَعلمات

الاسمالنوعالوصف
openLinkOpenLinkيشير ذلك المصطلح إلى كائن OpenLink يصف عنوان URL بأنّه سيتم فتحه.

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

Grid: هذا الكائن، للتسلسل.


setTitle(title)

تحدِّد هذه السياسة نص عنوان الشبكة. يجب أن يكون النص سلسلة عادية بدون تنسيق.

المَعلمات

الاسمالنوعالوصف
titleStringنص العنوان.

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

Grid: هذا الكائن، للتسلسل.