Class Chip

条状标签

带有图标和文本标签的 Chip。您可以根据需要停用该条状标签。

仅适用于 Google Chat 应用。不适用于 Google Workspace 插件。

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

方法

方法	返回类型	简介
setAltText(altText)	Chip	设置条状标签的替代文本以实现无障碍功能。
setAuthorizationAction(action)	Chip	设置授权操作，以便在用户点击相应对象时打开指向授权流程的网址。
setComposeAction(action, composedEmailType)	Chip	设置在用户点击对象时撰写电子邮件草稿的操作。
setDisabled(disabled)	Chip	设置条状标签是否已停用。
setIcon(icon)	Chip	设置要用作条状标签的图标。
setLabel(label)	Chip	设置条状标签的标题。
setOnClickAction(action)	Chip	设置在点击对象时执行的操作。
setOnClickOpenLinkAction(action)	Chip	设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)	Chip	设置在点击对象时要打开的网址。

详细文档

setAltText(altText)

设置条状标签的替代文本以实现无障碍功能。如果未设置，则默认为条状标签上显示的文本。

参数

名称	类型	说明
altText	String	要分配给此条状标签的替代文本。

返回

Chip - 此对象，用于链式调用。

---

setAuthorizationAction(action)

设置授权操作，以便在用户点击相应对象时打开指向授权流程的网址。系统随即会在新窗口中打开该网址。当用户完成授权流程并返回应用时，该插件会重新加载。

界面对象只能设置 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	用于指定在点击此元素时要执行的授权操作的对象。

返回

Chip - 此对象，用于链式调用。

---

setComposeAction(action, composedEmailType)

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

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

注意：此方法不会设置用于扩展 Compose 界面的 Compose 操作。 而是将此界面元素连接到一个 Action，该 Action 会在 Apps Script 中撰写草稿邮件，这些邮件会在操作完成后在 Gmail 中打开。

// ...

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	用于指定点击此元素时要执行的撰写操作的对象。
composedEmailType	ComposedEmailType	一个枚举值，用于指定撰写的草稿是独立草稿还是回复草稿。

返回

Chip - 此对象，用于链式调用。

---

setDisabled(disabled)

设置条状标签是否已停用。停用的条状标签会显示为灰色，无法点击。

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

参数

名称	类型	说明
disabled	Boolean	停用状态。

返回

Chip - 此对象，用于链式调用。

---

setIcon(icon)

设置要用作条状标签的图标。

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

参数

名称	类型	说明
icon	IconImage	预定义的 IconImage 值之一。

返回

Chip - 此对象，用于链式调用。

---

setLabel(label)

设置条状标签的标题。必填。

const chip = CardService.newChip().setLabel('bug Report');

参数

名称	类型	说明
label	String	要显示的文本。

返回

Chip - 此对象，用于链式调用。

---

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	点击此元素时要执行的操作。

返回

Chip - 此对象，用于链式调用。

---

setOnClickOpenLinkAction(action)

设置在用户点击对象时在标签页中打开网址的操作。当需要构建网址或除了创建 OpenLink 对象之外还需要执行其他操作时，请使用此函数。界面对象只能设置 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action) 或 setComposeAction(action, composedEmailType) 之一。

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

// ...

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	用于指定在用户点击此元素时要执行的打开链接操作的对象。

返回

Chip - 此对象，用于链式调用。

---

setOpenLink(openLink)

设置在点击对象时要打开的网址。当网址已知且只需打开时，请使用此函数。界面对象只能设置 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action) 或 setComposeAction(action, composedEmailType) 之一。

参数

名称	类型	说明
openLink	OpenLink	一个 OpenLink 对象，用于描述要打开的网址。

返回

Chip - 此对象，用于链式调用。