Class DecoratedText

DecoratedText

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

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

var decoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel");

var 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) 中的一个。

// ...

var 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 对象。

<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	一个枚举值，用于指定组合草稿是否为 或回复草稿。

返回

DecoratedText - 此对象，用于链接。

---

setEndIcon(endIcon)

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

参数

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

返回

DecoratedText - 此对象，用于链接。

---

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

返回

DecoratedText - 此对象，用于链接。

---

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	该对象指定了当此元素被触发时要执行的打开链接操作。 。

返回

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	此 widget 的文本内容。

返回

DecoratedText - 此对象，用于链接。

---

setTopLabel(text)

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

参数

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

返回

DecoratedText - 此对象，用于链接。

---

setWrapText(wrapText)

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

参数

名称	类型	说明
wrapText	Boolean	如果为 true，则文本会被自动换行并显示多行。其他情况 文本被截断。

返回

DecoratedText - 此对象，用于链接。