Class KeyValue

KeyValue

已弃用。此类已废弃，不应在新脚本中使用。

此类已废弃。请改用 DecoratedText。

方法

方法	返回类型	简介
setAuthorizationAction(action)	KeyValue	设置一项授权操作，该操作在用户点击对象时打开指向授权流程的网址。
setComposeAction(action, composedEmailType)	KeyValue	设置在点击对象时撰写电子邮件草稿的操作。
setOnClickAction(action)	KeyValue	设置在点击对象时执行的操作。
setOnClickOpenLinkAction(action)	KeyValue	设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)	KeyValue	设置在点击对象时要打开的网址。

已弃用的方法

方法	返回类型	简介
setBottomLabel(text)	KeyValue	设置要用作键的标签文本。
setButton(button)	KeyValue	设置显示在上下文右侧的 Button。
setContent(text)	KeyValue	设置要用作值的文本。
setIcon(icon)	KeyValue	设置要用作键的图标。
setIconAltText(altText)	KeyValue	设置图标的替代文本。
setIconUrl(url)	KeyValue	设置要用作键的图标的网址。
setMultiline(multiline)	KeyValue	设置值文本应显示在一行还是多行。
setSwitch(switchToSet)	KeyValue	设置显示在内容右侧的 Switch。
setTopLabel(text)	KeyValue	设置要用作键的标签文本。

详细文档

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

返回

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

---

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() {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

参数

名称	类型	说明
action	Action	用于指定点击此元素时要执行的合成操作的对象。
composedEmailType	ComposedEmailType	一个枚举值，用于指定撰写的草稿是独立草稿还是回复草稿。

返回

KeyValue - 此对象，用于实现链式连接。

---

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

返回

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

---

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

返回

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

---

setOpenLink(openLink)

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

参数

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

返回

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

已弃用的方法

setBottomLabel(text)

已弃用。此函数已废弃，不应在新脚本中使用。

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

参数

名称	类型	说明
text	String	标签文本。注意：不支持基本 HTML 格式。

返回

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

---

setButton(button)

已弃用。此函数已废弃，不应在新脚本中使用。

设置显示在上下文右侧的 Button。一个 KeyValue 只能支持一个按钮、一个开关或一个图标。

参数

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

返回

KeyValue - 此对象，用于实现链式连接。

---

setContent(text)

已弃用。此函数已废弃，不应在新脚本中使用。

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

参数

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

返回

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

---

setIcon(icon)

已弃用。此函数已废弃，不应在新脚本中使用。

设置要用作键的图标。

参数

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

返回

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

---

setIconAltText(altText)

已弃用。此函数已废弃，不应在新脚本中使用。

设置图标的替代文本。

参数

名称	类型	说明
altText	String	图标的替代文本。

返回

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

---

setIconUrl(url)

已弃用。此函数已弃用，不应在新脚本中使用。

设置要用作键的图标的网址。

参数

名称	类型	说明
url	String	要用作图标的托管图片的网址。

返回

KeyValue - 此对象，用于实现链式连接。

---

setMultiline(multiline)

已弃用。此函数已废弃，不应在新脚本中使用。

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

参数

名称	类型	说明
multiline	Boolean	多行设置。

返回

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

---

setSwitch(switchToSet)

已弃用。此函数已废弃，不应在新脚本中使用。

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

参数

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

返回

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

---

setTopLabel(text)

已弃用。此函数已废弃，不应在新脚本中使用。

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

参数

名称	类型	说明
text	String	标签文本。注意：不支持基本 HTML 格式。

返回

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