Class DecoratedText

带装饰的文本

用于显示带有可选装饰的文本的 widget。可能的按键包括图标、上方标签和下方标签。必须使用 setText(text) 和 DecoratedText、DecoratedText、setTopLabel(text) 或 setBottomLabel(text) 之一来设置文本内容和其中一个键。此类旨在替换 KeyValue。

适用于 Google Workspace 插件和 Google Chat 应用。

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

方法

方法	返回类型	简介
setAuthorizationAction(action)	DecoratedText	设置授权操作，以便在用户点击相应对象时打开指向授权流程的网址。
setBottomLabel(text)	DecoratedText	设置要用作键的标签文本，该文本会显示在文本内容下方。
setButton(button)	DecoratedText	设置显示在文本右侧的 Button。
setComposeAction(action, composedEmailType)	DecoratedText	设置在用户点击对象时撰写电子邮件草稿的操作。
setEndIcon(endIcon)	DecoratedText	设置显示在内容右侧的可选 IconImage。
setOnClickAction(action)	DecoratedText	设置在点击对象时执行的操作。
setOnClickOpenLinkAction(action)	DecoratedText	设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)	DecoratedText	设置在点击对象时要打开的网址。
setStartIcon(startIcon)	DecoratedText	设置要在文本内容之前显示的可选 IconImage。
setSwitchControl(switchToSet)	DecoratedText	设置显示在内容右侧的 Switch。
setText(text)	DecoratedText	设置要用作值的文本。
setTopLabel(text)	DecoratedText	设置要用作键的标签文本，该文本会显示在文本内容上方。
setWrapText(wrapText)	DecoratedText	设置值文本应显示在一行还是多行。

详细文档

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

返回

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

---

setBottomLabel(text)

设置要用作键的标签文本，该文本会显示在文本内容下方。

参数

名称	类型	说明
text	String	标签文本。

返回

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

---

setButton(button)

设置显示在文本右侧的 Button。一个 DecoratedText 只能支持一个按钮或一个开关。

参数

名称	类型	说明
button	Button	用于添加的按钮。

返回

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

---

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	一个枚举值，用于指定撰写的草稿是独立草稿还是回复草稿。

返回

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

---

setEndIcon(endIcon)

设置显示在内容右侧的可选 IconImage。DecoratedText 只能支持一个按钮、一个开关或一个图标。

参数

名称	类型	说明
endIcon	IconImage	要添加的图标。

返回

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

---

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

返回

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

---

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

返回

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

---

setOpenLink(openLink)

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

参数

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

返回

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

---

setStartIcon(startIcon)

设置要在文本内容之前显示的可选 IconImage。

参数

名称	类型	说明
startIcon	IconImage	要显示的图标。

返回

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

---

setSwitchControl(switchToSet)

设置显示在内容右侧的 Switch。DecoratedText 只能支持一个按钮或一个开关。

参数

名称	类型	说明
switchToSet	Switch	要添加的开关。

返回

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

---

setText(text)

设置要用作值的文本。支持基本 HTML 格式。必填。

参数

名称	类型	说明
text	String	此微件的文本内容。

返回

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

---

setTopLabel(text)

设置要用作键的标签文本，该文本会显示在文本内容上方。

参数

名称	类型	说明
text	String	标签文本。

返回

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

---

setWrapText(wrapText)

设置值文本应显示在一行还是多行。

参数

名称	类型	说明
wrapText	Boolean	如果为 true，系统会换行显示文本。否则，系统会截断文本。

返回

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