Class Grid

شبکه

یک شبکه سازماندهی شده برای نمایش مجموعه‌ای از آیتم‌های شبکه‌ای.

برای افزونه‌های Google Workspace و برنامه‌های Google Chat در دسترس است.

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

روش‌ها

روش نوع بازگشتی شرح مختصر
add Event Action(eventAction) Widget رویدادی را اضافه می‌کند که می‌توان روی ویجت اجرا کرد.
add Item(gridItem) Grid یک آیتم شبکه جدید به شبکه اضافه می‌کند.
set Authorization Action(action) Grid یک عمل مجوزدهی تنظیم می‌کند که وقتی روی شیء کلیک می‌شود، یک URL به جریان مجوزدهی باز می‌کند.
set Border Style(borderStyle) Grid سبک حاشیه‌ای که برای هر آیتم شبکه‌ای اعمال می‌شود را تنظیم می‌کند.
set Compose Action(action, composedEmailType) Grid عملی را تنظیم می‌کند که هنگام کلیک روی شیء، یک ایمیل پیش‌نویس ایجاد می‌کند.
set Id(id) Widget شناسه منحصر به فرد اختصاص داده شده برای شناسایی ویجت مورد نظر برای تغییر را تنظیم می‌کند.
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 متن عنوان شبکه را تنظیم می‌کند.
set Visibility(visibility) Widget میزان نمایش ویجت را تنظیم می‌کند.

مستندات دقیق

add Event Action(eventAction)

رویدادی را اضافه می‌کند که می‌توان روی ویجت اجرا کرد.

پارامترها

نام نوع توضیحات
event Action Event Action Event Action قرار است اضافه شود.

بازگشت

Widget — شیء، برای زنجیره‌سازی.

add Item(gridItem)

یک آیتم شبکه جدید به شبکه اضافه می‌کند.

پارامترها

نام نوع توضیحات
grid Item Grid Item آیتم شبکه‌ای که باید اضافه شود.

بازگشت

Grid - این شیء، برای زنجیره‌سازی.

set Authorization Action(action)

یک عمل مجوزدهی تنظیم می‌کند که وقتی روی شیء کلیک می‌شود، یک URL به جریان مجوزدهی باز می‌کند. این URL را در یک پنجره جدید باز می‌کند. وقتی کاربر جریان مجوزدهی را تمام می‌کند و به برنامه برمی‌گردد، افزونه دوباره بارگذاری می‌شود.

یک شیء رابط کاربری فقط می‌تواند یکی از 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 شیء‌ای که مشخص می‌کند هنگام کلیک روی این عنصر، چه عملی برای نوشتن انجام شود.
composed Email Type Composed Email Type یک مقدار شمارشی که مشخص می‌کند آیا پیش‌نویس نوشته شده، یک پیش‌نویس مستقل است یا پاسخی.

بازگشت

Grid - این شیء، برای زنجیره‌سازی.

set Id(id)

شناسه منحصر به فردی که برای شناسایی ویجت مورد نظر برای تغییر استفاده می‌شود را تنظیم می‌کند. تغییر ویجت فقط در افزونه‌ها پشتیبانی می‌شود.

پارامترها

نام نوع توضیحات
id String شناسه‌ی ویجت، با محدودیت ۶۴ کاراکتر و با فرمت `[a-zA-Z0-9-]+`.

بازگشت

Widget - این شیء، برای زنجیره‌سازی.

set Num Columns(numColumns)

تعداد ستون‌هایی که در جدول نمایش داده می‌شوند. اگر در پنل سمت راست نشان داده شود، می‌توانید ۱-۲ ستون را نمایش دهید و مقدار پیش‌فرض ۱ است. اگر در یک کادر محاوره‌ای نشان داده شود، می‌توانید ۲-۳ ستون را نمایش دهید و مقدار پیش‌فرض ۲ است.

پارامترها

نام نوع توضیحات
num Columns Integer تعداد ستون‌ها.

بازگشت

Grid - این شیء، برای زنجیره‌سازی.

set On Click Action(action)

عملی را تنظیم می‌کند که هنگام کلیک روی شیء اجرا می‌شود. یک شیء رابط کاربری فقط می‌تواند یکی از 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 function) را مشخص کند که یک شیء 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 باید یک تابع فراخوانی را مشخص کند که یک شیء 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 - این شیء، برای زنجیره‌سازی.

یک 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 - این شیء، برای زنجیره‌سازی.

set Visibility(visibility)

میزان نمایش ویجت را تنظیم می‌کند. مقدار پیش‌فرض آن `VISIBLE` است.

پارامترها

نام نوع توضیحات
visibility Visibility Visibility ویجت.

بازگشت

Widget — شیء، برای زنجیره‌سازی.