Class DecoratedText

DecoratedText

显示带有可选装饰的文本的微件。可能的键包括图标、上面一个标签和下面的标签。必须使用 setText(text) 以及 DecoratedTextDecoratedTextsetTopLabel(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);

参数

名称类型说明
actionAuthorizationAction用于指定点击此元素时要执行的授权操作的对象。

弃踢回攻

DecoratedText - 此对象,用于链接。


setBottomLabel(text)

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

参数

名称类型说明
textString标签文本。

弃踢回攻

DecoratedText - 此对象,用于链接。


setButton(button)

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

参数

名称类型说明
buttonButton要添加的按钮。

弃踢回攻

DecoratedText - 此对象,用于链接。


setComposeAction(action, composedEmailType)

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

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

// ...

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

参数

名称类型说明
actionAction用于指定点击此元素时要执行的合成操作的对象。
composedEmailTypeComposedEmailType一个枚举值,用于指定组合的草稿是独立草稿还是回复草稿。

弃踢回攻

DecoratedText - 此对象,用于链接。


setEndIcon(endIcon)

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

参数

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

弃踢回攻

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

参数

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

弃踢回攻

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

参数

名称类型说明
actionAction用于指定点击此元素时要执行的打开链接操作的对象。

弃踢回攻

DecoratedText - 此对象,用于链接。


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

参数

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

弃踢回攻

DecoratedText - 此对象,用于链接。


setStartIcon(startIcon)

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

参数

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

弃踢回攻

DecoratedText - 此对象,用于链接。


setSwitchControl(switchToSet)

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

参数

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

弃踢回攻

DecoratedText - 此对象,用于链接。


setText(text)

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

参数

名称类型说明
textString此 widget 的文本内容。

弃踢回攻

DecoratedText - 此对象,用于链接。


setTopLabel(text)

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

参数

名称类型说明
textString标签文本。

弃踢回攻

DecoratedText - 此对象,用于链接。


setWrapText(wrapText)

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

参数

名称类型说明
wrapTextBoolean如果为 true,则文本会换行并显示多行。否则,文本将被截断。

弃踢回攻

DecoratedText - 此对象,用于链接。