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');

方法

方法	返回类型	简介
`addEventAction(eventAction)`	`Widget`	添加可在 widget 上执行的事件操作。
`setAuthorizationAction(action)`	`DecoratedText`	设置授权操作，以便在点击对象时打开网址以进入授权流程。
`setBottomLabel(text)`	`DecoratedText`	设置用作键且显示在文本内容下方的标签文本。
`setButton(button)`	`DecoratedText`	设置显示在文字右侧的 `Button`。
`setComposeAction(action, composedEmailType)`	`DecoratedText`	设置在点击对象时撰写电子邮件草稿的操作。
`setEndIcon(endIcon)`	`DecoratedText`	设置显示在内容右侧的可选 `IconImage`。
`setId(id)`	`Widget`	设置用于标识要发生变异的 widget 的唯一 ID。
`setOnClickAction(action)`	`DecoratedText`	设置在点击对象时执行的操作。
`setOnClickOpenLinkAction(action)`	`DecoratedText`	设置一项操作，以便在点击对象时在标签页中打开网址。
`setOpenLink(openLink)`	`DecoratedText`	设置在点击对象时要打开的网址。
`setStartIcon(startIcon)`	`DecoratedText`	设置要在文本内容之前显示的可选 `IconImage`。
`setSwitchControl(switchToSet)`	`DecoratedText`	设置显示在内容右侧的 `Switch`。
`setText(text)`	`DecoratedText`	设置要用作值的文本。
`setTopLabel(text)`	`DecoratedText`	设置用作键且显示在文本内容上方的标签文本。
`setVisibility(visibility)`	`Widget`	设置 widget 的可见性。
`setWrapText(wrapText)`	`DecoratedText`	设置值文本是应显示在单行上还是多行上。

详细文档

`addEventAction(eventAction)`

添加可在 widget 上执行的事件操作。

参数

名称	类型	说明
`eventAction`	`EventAction`	要添加的 `EventAction`。

Widget - 用于链式调用的对象。

`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 脚本中撰写草稿邮件，并在操作完成后在 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 - 此对象，用于链式调用。

`setId(id)`

设置用于标识要发生变异的 widget 的唯一 ID。只有在插件中支持 widget 突变。

参数

名称	类型	说明
`id`	`String`	微件的 ID，长度限制为 64 个字符，格式为 `[a-zA-Z0-9-]+`。

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

`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 - 此对象，用于链式调用。

`setVisibility(visibility)`

设置 widget 的可见性。默认值为 `VISIBLE`。

参数

名称	类型	说明
`visibility`	`Visibility`	微件的 `Visibility`。

Widget - 用于链式调用的对象。

`setWrapText(wrapText)`

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

参数

名称	类型	说明
`wrapText`	`Boolean`	如果值为 `true`，则文本会换行并显示在多行中。否则，文本会被截断。

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

Class DecoratedText 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

方法

详细文档

addEventAction(eventAction)

参数

返回

setAuthorizationAction(action)

参数

返回

setBottomLabel(text)

参数

返回

setButton(button)

参数

返回

setComposeAction(action, composedEmailType)

参数

返回

setEndIcon(endIcon)

参数

返回

setId(id)

参数

返回

setOnClickAction(action)

参数

返回

setOnClickOpenLinkAction(action)

参数

返回

setOpenLink(openLink)

参数

返回

setStartIcon(startIcon)

参数

返回

setSwitchControl(switchToSet)

参数

返回

setText(text)

参数

返回

setTopLabel(text)

参数

返回

setVisibility(visibility)

参数

返回

setWrapText(wrapText)

参数

返回

Class DecoratedText

`addEventAction(eventAction)`

`setAuthorizationAction(action)`

`setBottomLabel(text)`

`setButton(button)`

`setComposeAction(action, composedEmailType)`

`setEndIcon(endIcon)`

`setId(id)`

`setOnClickAction(action)`

`setOnClickOpenLinkAction(action)`

`setOpenLink(openLink)`

`setStartIcon(startIcon)`

`setSwitchControl(switchToSet)`

`setText(text)`

`setTopLabel(text)`

`setVisibility(visibility)`

`setWrapText(wrapText)`