Class KeyValue

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

此类已弃用。请改用 DecoratedText

方法

方法返回类型简介
addEventAction(eventAction)Widget添加可在 widget 上执行的事件操作。
setAuthorizationAction(action)KeyValue设置授权操作,以便在点击对象时打开网址以进入授权流程。
setComposeAction(action, composedEmailType)KeyValue设置在点击对象时撰写电子邮件草稿的操作。
setId(id)Widget设置用于标识要发生变异的 widget 的唯一 ID。
setOnClickAction(action)KeyValue设置在点击对象时执行的操作。
setOnClickOpenLinkAction(action)KeyValue设置一项操作,以便在点击对象时在标签页中打开网址。
setOpenLink(openLink)KeyValue设置在点击对象时要打开的网址。
setVisibility(visibility)Widget设置 widget 的可见性。

详细文档

addEventAction(eventAction)

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

参数

名称类型说明
eventActionEventAction要添加的 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);

参数

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

返回

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


setComposeAction(action, composedEmailType)

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

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

// ...

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

参数

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

返回

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


setId(id)

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

参数

名称类型说明
idString微件的 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();
}

参数

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

返回

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

参数

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

返回

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


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

参数

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

返回

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


setVisibility(visibility)

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

参数

名称类型说明
visibilityVisibility微件的 Visibility

返回

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

已弃用的方法