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الكائن الذي يحدد إجراء Compose المطلوب اتخاذه عندما يكون هذا العنصر النقر عليه.
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 — هذا العنصر، للتسلسل.