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	设置一项授权操作，该操作会在对象被 。
setBorderStyle(borderStyle)	Grid	设置应用于每个网格项的边框样式。
setComposeAction(action, composedEmailType)	Grid	设置在点击对象时撰写电子邮件草稿的操作。
setNumColumns(numColumns)	Grid	要在网格中显示的列数。
setOnClickAction(action)	Grid	设置点击对象时执行的操作。
setOnClickOpenLinkAction(action)	Grid	设置在点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)	Grid	设置点击对象时要打开的网址。
setTitle(title)	Grid	设置网格的标题文本。

详细文档

addItem(gridItem)

向网格添加新的网格项。

参数

名称	类型	说明
gridItem	GridItem	要添加的网格项。

返回

Grid - 此对象，用于链接。

---

setAuthorizationAction(action)

设置一项授权操作，该操作会在对象被 。系统会在新窗口中打开该网址。当用户完成授权流程并 返回应用，该插件会重新加载。

一个界面对象只能设置 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)

设置在点击对象时撰写电子邮件草稿的操作。一个界面对象只能 具有 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、 已设置 setAuthorizationAction(action) 或 setComposeAction(action, composedEmailType)。

Action 参数必须指定回调函数，该函数可返回使用 ComposeActionResponseBuilder.setGmailDraft(draft) 配置的 ComposeActionResponse 对象。

<ph type="x-smartling-placeholder">

</ph> 注意：此方法不会设置会直接影响您的撰写操作 用于扩展撰写界面。 相反，此方法会将此界面元素连接到一个 Action，后者用于在 Apps 脚本中撰写消息草稿， 会在 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	该对象用于指定在此元素处于以下状态时要执行的撰写操作 。
composedEmailType	ComposedEmailType	一个枚举值，用于指定组合草稿是否为 或回复草稿。

返回

Grid - 此对象，用于链接。

---

setNumColumns(numColumns)

要在网格中显示的列数。如果显示在右侧面板中 1-2 列，默认值为 1。如果对话框中显示有 2-3 列， 默认值为 2。

参数

名称	类型	说明
numColumns	Integer	列数。

返回

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

参数

名称	类型	说明
action	Action	点击此元素时要执行的操作。

返回

Grid - 此对象，用于链接。

---

setOnClickOpenLinkAction(action)

设置在点击对象时在标签页中打开网址的操作。在以下情况下，请使用此函数： 需要构建网址，或者您还需要执行其他操作以创建 OpenLink 对象。一个界面对象只能具有 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action) 或 已设置 setComposeAction(action, composedEmailType)。

Action 参数必须指定回调函数，该函数可返回使用 ActionResponseBuilder.setOpenLink(openLink) 配置的 ActionResponse 对象。

// ...

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)

设置点击对象时要打开的网址。如果网址已存在，请使用此函数 只需将其打开一个界面对象只能具有 setOpenLink(openLink)、 setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、 或 setComposeAction(action, composedEmailType)。

参数

名称	类型	说明
openLink	OpenLink	描述要打开的网址的 OpenLink 对象。

返回

Grid - 此对象，用于链接。

---

setTitle(title)

设置网格的标题文本。文本必须是不带格式的纯字符串。

参数

名称	类型	说明
title	String	标题文本。

返回

Grid - 此对象，用于链接。