یک شبکه سازمان یافته برای نمایش مجموعه ای از آیتم های شبکه.
برای افزونههای Google Workspace و برنامههای Google Chat موجود است.
const grid = CardService.newGrid().setTitle('My Grid').setNumColumns(2).addItem( CardService.newGridItem().setTitle('My item'));
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
add Item(gridItem) | Grid | یک مورد شبکه جدید را به شبکه اضافه می کند. |
set Authorization Action(action) | Grid | یک اقدام مجوز را تنظیم می کند که با کلیک روی شی، یک URL را به جریان مجوز باز می کند. |
set Border Style(borderStyle) | Grid | سبک حاشیه اعمال شده برای هر مورد شبکه را تنظیم می کند. |
set Compose Action(action, composedEmailType) | Grid | اقدامی را تنظیم میکند که با کلیک روی شی، یک ایمیل پیشنویس مینویسد. |
set Num Columns(numColumns) | Grid | تعداد ستون هایی که در شبکه نمایش داده می شود. |
set On Click Action(action) | Grid | عملی را تنظیم می کند که با کلیک روی شی اجرا شود. |
set On Click Open Link Action(action) | Grid | عملکردی را تنظیم می کند که با کلیک روی شی، URL را در یک برگه باز می کند. |
set Open Link(openLink) | Grid | یک URL را تنظیم می کند که با کلیک روی شیء باز شود. |
set Title(title) | Grid | متن عنوان شبکه را تنظیم می کند. |
مستندات دقیق
add Item(gridItem)
set Authorization Action(action)
یک اقدام مجوز را تنظیم می کند که با کلیک روی شی، یک URL را به جریان مجوز باز می کند. این URL را در یک پنجره جدید باز می کند. هنگامی که کاربر جریان مجوز را تمام کرد و به برنامه بازگشت، افزونه بارگیری مجدد می شود.
یک شی UI فقط میتواند یکی از set Open Link(openLink)
، set On Click Action(action)
، set On Click Open Link Action(action)
، set Authorization Action(action)
یا set Compose Action(action, composedEmailType)
مجموعه را داشته باشد. .
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
action | Authorization Action | شیئی که اقدام مجوزی را که باید هنگام کلیک روی این عنصر انجام شود را مشخص می کند. |
بازگشت
Grid
- این شی، برای زنجیر کردن.
set Border Style(borderStyle)
سبک حاشیه اعمال شده برای هر مورد شبکه را تنظیم می کند. پیش فرض NO_BORDER است.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
border Style | Border Style | سبک حاشیه برای اعمال. |
بازگشت
Grid
- این شی، برای زنجیر کردن.
set Compose Action(action, composedEmailType)
اقدامی را تنظیم میکند که با کلیک روی شی، یک ایمیل پیشنویس مینویسد. یک شی UI فقط میتواند یکی از set Open Link(openLink)
، set On Click Action(action)
، set On Click Open Link Action(action)
، set Authorization Action(action)
یا set Compose Action(action, composedEmailType)
مجموعه را داشته باشد. .
پارامتر Action
باید تابع فراخوانی را مشخص کند که شیء Compose Action Response
پیکربندی شده با استفاده از Compose Action Response Builder.setGmailDraft(draft)
را برمی گرداند.
// ... const action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback(e) { const thread = GmailApp.getThreadById(e.threadId); const draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
action | Action | شیئی که عمل compose را مشخص می کند که هنگام کلیک روی این عنصر انجام شود. |
composed Email Type | Composed Email Type | یک مقدار enum که مشخص می کند پیش نویس تشکیل شده یک پیش نویس مستقل است یا پاسخ. |
بازگشت
Grid
- این شی، برای زنجیر کردن.
set Num Columns(numColumns)
تعداد ستون هایی که در شبکه نمایش داده می شود. اگر در پانل سمت راست نشان داده شده است، می توانید 1-2 ستون را نمایش دهید و مقدار پیش فرض 1 است. اگر در یک گفتگو نشان داده شده است، می توانید 2-3 ستون را نمایش دهید و مقدار پیش فرض 2 است.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
num Columns | Integer | تعداد ستون ها |
بازگشت
Grid
- این شی، برای زنجیر کردن.
set On Click Action(action)
عملی را تنظیم می کند که با کلیک روی شی اجرا شود. یک شی UI فقط میتواند یکی از set Open Link(openLink)
، set On Click Action(action)
، set On Click Open Link Action(action)
، set Authorization Action(action)
یا set Compose Action(action, composedEmailType)
مجموعه را داشته باشد. .
پارامتر Action
باید تابع callback را مشخص کند که یک شی Action Response
برمی گرداند.
// ... 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
- این شی، برای زنجیر کردن.
set On Click Open Link Action(action)
عملکردی را تنظیم می کند که با کلیک روی شی، URL را در یک برگه باز می کند. از این تابع زمانی استفاده کنید که URL باید ساخته شود یا زمانی که باید اقدامات دیگری را علاوه بر ایجاد شیء Open Link
انجام دهید. یک شی UI فقط میتواند یکی از set Open Link(openLink)
، set On Click Action(action)
، set On Click Open Link Action(action)
، set Authorization Action(action)
یا set Compose Action(action, composedEmailType)
مجموعه را داشته باشد. .
پارامتر Action
باید یک تابع callback را مشخص کند که یک شی Action Response
پیکربندی شده با استفاده از Action Response Builder.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
- این شی، برای زنجیر کردن.
set Open Link(openLink)
یک URL را تنظیم می کند که با کلیک روی شیء باز شود. از این تابع زمانی استفاده کنید که URL از قبل شناخته شده باشد و فقط باید باز شود. یک شی UI فقط میتواند یکی از set Open Link(openLink)
، set On Click Action(action)
، set On Click Open Link Action(action)
، set Authorization Action(action)
یا set Compose Action(action, composedEmailType)
مجموعه را داشته باشد. .
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
open Link | Open Link | یک شی Open Link که URL مورد نظر را برای باز کردن توصیف می کند. |
بازگشت
Grid
- این شی، برای زنجیر کردن.
set Title(title)
متن عنوان شبکه را تنظیم می کند. متن باید یک رشته ساده و بدون قالب بندی باشد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
title | String | متن عنوان |
بازگشت
Grid
- این شی، برای زنجیر کردن.