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)

یک مورد شبکه جدید را به شبکه اضافه می کند.

مولفه های

نام	تایپ کنید	شرح
gridItem	GridItem	مورد شبکه برای افزودن.

برگشت

Grid - این شی، برای زنجیر کردن.

---

setAuthorizationAction(action)

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

یک شی UI فقط می تواند یکی از مجموعه های setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) داشته باشد.

// ...

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

مولفه های

نام	تایپ کنید	شرح
action	AuthorizationAction	شیئی که اقدام مجوزی را که باید هنگام کلیک روی این عنصر انجام شود را مشخص می کند.

برگشت

Grid - این شی، برای زنجیر کردن.

---

setBorderStyle(borderStyle)

سبک حاشیه اعمال شده برای هر مورد شبکه را تنظیم می کند. پیش فرض NO_BORDER است.

مولفه های

نام	تایپ کنید	شرح
borderStyle	BorderStyle	سبک حاشیه برای اعمال.

برگشت

Grid - این شی، برای زنجیر کردن.

---

setComposeAction(action, composedEmailType)

اقدامی را تنظیم می‌کند که با کلیک روی شی، یک ایمیل پیش‌نویس می‌نویسد. یک شی UI فقط می تواند یکی از مجموعه های setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) داشته باشد.

پارامتر Action باید تابع callback را مشخص کند که یک شی ComposeActionResponse پیکربندی شده با استفاده از ComposeActionResponseBuilder.setGmailDraft(draft) را برمی گرداند.

توجه : این روش یک عملکرد نوشتن را تنظیم نمی کند که برای گسترش رابط کاربری نوشتن استفاده می شود. در عوض، این روش این عنصر رابط کاربری را به یک Action متصل می‌کند که پیام‌های پیش‌نویس را در Apps Script می‌سازد که پس از تکمیل عملکرد در Gmail باز می‌شوند.

// ...

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();
}

مولفه های

نام	تایپ کنید	شرح
action	Action	شیئی که عمل compose را مشخص می کند که هنگام کلیک روی این عنصر انجام شود.
composedEmailType	ComposedEmailType	یک مقدار enum که مشخص می کند پیش نویس تشکیل شده یک پیش نویس مستقل است یا پاسخ.

برگشت

Grid - این شی، برای زنجیر کردن.

---

setNumColumns(numColumns)

تعداد ستون هایی که در شبکه نمایش داده می شود. اگر در پانل سمت راست نشان داده شده است، می توانید 1-2 ستون را نمایش دهید و مقدار پیش فرض 1 است. اگر در یک گفتگو نشان داده شده است، می توانید 2-3 ستون را نمایش دهید و مقدار پیش فرض 2 است.

مولفه های

نام	تایپ کنید	شرح
numColumns	Integer	تعداد ستون ها

برگشت

Grid - این شی، برای زنجیر کردن.

---

setOnClickAction(action)

عملی را تنظیم می کند که با کلیک روی شی اجرا شود. یک شی UI فقط می تواند یکی از مجموعه های setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) داشته باشد.

پارامتر Action باید تابع callback را مشخص کند که یک شی 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();
}

مولفه های

نام	تایپ کنید	شرح
action	Action	اقدامی که باید هنگام کلیک روی این عنصر انجام شود.

برگشت

Grid - این شی، برای زنجیر کردن.

---

setOnClickOpenLinkAction(action)

عملکردی را تنظیم می کند که با کلیک روی شی، URL را در یک برگه باز می کند. زمانی که باید URL ساخته شود یا زمانی که باید اقدامات دیگری را علاوه بر ایجاد شی OpenLink انجام دهید، از این تابع استفاده کنید. یک شی UI فقط می تواند یکی از مجموعه های setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) داشته باشد.

پارامتر Action باید تابع callback را مشخص کند که یک شی 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();
}

مولفه های

نام	تایپ کنید	شرح
action	Action	شیئی که عمل پیوند باز را مشخص می کند که هنگام کلیک روی این عنصر انجام شود.

برگشت

Grid - این شی، برای زنجیر کردن.

---

setOpenLink(openLink)

یک URL را تنظیم می کند که با کلیک روی شیء باز شود. از این تابع زمانی استفاده کنید که URL از قبل شناخته شده باشد و فقط باید باز شود. یک شی UI فقط می‌تواند یکی از مجموعه‌های setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) داشته باشد.

مولفه های

نام	تایپ کنید	شرح
openLink	OpenLink	یک شی OpenLink که URL مورد نظر را برای باز کردن توصیف می کند.

برگشت

Grid - این شی، برای زنجیر کردن.

---

setTitle(title)

متن عنوان شبکه را تنظیم می کند. متن باید یک رشته ساده و بدون قالب بندی باشد.

مولفه های

نام	تایپ کنید	شرح
title	String	متن عنوان.

برگشت

Grid - این شی، برای زنجیر کردن.