شبكة منظَّمة لعرض مجموعة من عناصر الشبكة
تتوفّر هذه الميزة لإضافات Google Workspace وتطبيقات Google Chat.
const 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)
setAuthorizationAction(action)
تُستخدَم لضبط إجراء تفويض يفتح عنوان URL يؤدي إلى مسار التفويض عند النقر على العنصر. يؤدي ذلك إلى فتح عنوان URL في نافذة جديدة. عندما ينتهي المستخدم من مسار التفويض ويعود إلى التطبيق، تتم إعادة تحميل الإضافة.
لا يمكن ضبط عنصر واجهة المستخدم إلا على أحد القيم التالية: setOpenLink(openLink)
أو setOnClickAction(action)
أو setOnClickOpenLinkAction(action)
أو setAuthorizationAction(action)
أو setComposeAction(action, composedEmailType)
.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
المعلمات
الاسم | النوع | الوصف |
---|---|---|
action | AuthorizationAction | العنصر الذي يحدّد إجراء التفويض الذي يجب اتّخاذه عند النقر على هذا العنصر |
الإرجاع
Grid
: هذا العنصر، لإنشاء سلسلة.
setBorderStyle(borderStyle)
لضبط نمط الحدود الذي يتم تطبيقه على كل عنصر من عناصر الشبكة. القيمة التلقائية هي NO_BORDER.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
borderStyle | BorderStyle | نمط الحدّ المطلوب تطبيقه |
الإرجاع
Grid
: هذا العنصر، لإنشاء سلسلة.
setComposeAction(action, composedEmailType)
تُستخدَم لضبط إجراء ينشئ مسودة رسالة إلكترونية عند النقر على العنصر. يمكن أن يحتوي عنصر واجهة المستخدم على أحد العناصر التالية فقط: setOpenLink(openLink)
أو setOnClickAction(action)
أو setOnClickOpenLinkAction(action)
أو
setAuthorizationAction(action)
أو setComposeAction(action, composedEmailType)
.
يجب أن تحدّد المَعلمة Action
دالة ردّ اتصال تعرِض عنصر ComposeActionResponse
تمّ إعداده باستخدام ComposeActionResponseBuilder.setGmailDraft(draft)
.
// ... const action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback() { const thread = GmailApp.getThreadById(e.threadId); const draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
المعلمات
الاسم | النوع | الوصف |
---|---|---|
action | Action | العنصر الذي يحدّد إجراء الإنشاء الذي يجب اتّخاذه عند النقر على هذا العنصر |
composedEmailType | ComposedEmailType | قيمة مصنّفة تحدد ما إذا كانت المسودة التي تم إنشاؤها هي مسودة مستقلة أو مسودة ردّ. |
الإرجاع
Grid
: هذا العنصر، لإنشاء سلسلة.
setNumColumns(numColumns)
عدد الأعمدة المطلوب عرضها في الشبكة إذا كان يتم عرضه في اللوحة الجانبية اليمنى، يمكنك عرض عمودَين أو عمود واحد، وتكون القيمة التلقائية هي 1. إذا تم عرضها في مربّع حوار، يمكنك عرض عمودَين أو 3 أعمدة، وتكون القيمة التلقائية هي 2.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
numColumns | Integer | عدد الأعمدة |
الإرجاع
Grid
: هذا العنصر، لإنشاء سلسلة.
setOnClickAction(action)
تحدِّد هذه السياسة إجراءً يتم تنفيذه عند النقر على العنصر. لا يمكن أن يتضمّن عنصر واجهة المستخدم سوى أحد الإعدادات التالية:
setOpenLink(openLink)
أو setOnClickAction(action)
أو setOnClickOpenLinkAction(action)
أو setAuthorizationAction(action)
أو setComposeAction(action, composedEmailType)
.
يجب أن تحدّد المَعلمة Action
دالة ردّ اتصال تعرِض عنصر ActionResponse
.
// ... const 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(); }
المعلمات
الاسم | النوع | الوصف |
---|---|---|
action | Action | الإجراء الذي يتم اتخاذه عند النقر على هذا العنصر. |
الإرجاع
Grid
: هذا العنصر، لإنشاء سلسلة.
setOnClickOpenLinkAction(action)
تضبط هذه السياسة إجراءً يؤدي إلى فتح عنوان URL في علامة تبويب عند النقر على العنصر. يمكنك استخدام هذه الدالة عند الحاجة إلى إنشاء عنوان URL أو اتّخاذ إجراءات أخرى بالإضافة إلى إنشاء عنصر OpenLink
. لا يمكن أن يتضمّن عنصر واجهة المستخدم سوى أحد القيم التالية: setOpenLink(openLink)
أو setOnClickAction(action)
أو setOnClickOpenLinkAction(action)
أو setAuthorizationAction(action)
أو
setComposeAction(action, composedEmailType)
.
يجب أن تحدّد المَعلمة Action
دالة ردّ اتصال تعرِض عنصر ActionResponse
تمّ إعداده باستخدام ActionResponseBuilder.setOpenLink(openLink)
.
// ... const 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(); }
المعلمات
الاسم | النوع | الوصف |
---|---|---|
action | Action | الكائن الذي يحدد إجراء فتح الرابط الذي يجب اتخاذه عند النقر على هذا العنصر. |
الإرجاع
Grid
: هذا العنصر، لإنشاء سلسلة.
setOpenLink(openLink)
تُستخدَم لضبط عنوان URL ليتم فتحه عند النقر على العنصر. يمكنك استخدام هذه الدالة عندما يكون عنوان URL
معروفًا بالفعل ويجب فتحه فقط. يمكن أن يحتوي كائن واجهة المستخدم على مجموعة واحدة فقط من setOpenLink(openLink)
أو setOnClickAction(action)
أو setOnClickOpenLinkAction(action)
أو setAuthorizationAction(action)
أو setComposeAction(action, composedEmailType)
.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
openLink | OpenLink | عنصر OpenLink يصف عنوان URL المطلوب فتحه |
الإرجاع
Grid
: هذا العنصر، لإنشاء سلسلة.
setTitle(title)
لضبط نص عنوان الشبكة يجب أن يكون النص سلسلة عادية بدون تنسيق.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
title | String | نص العنوان |
الإرجاع
Grid
: هذا العنصر، لإنشاء سلسلة.