Class TextButton

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

带有文本标签的 TextButton。您可以根据需要设置背景颜色并停用该按钮。

var textButton = CardService.newTextButton()
    .setText("Open Link")
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://www.google.com"));

方法

方法返回类型简介
setAltText(altText)TextButton设置按钮的替代文字,以提供无障碍功能。
setAuthorizationAction(action)TextButton设置一项授权操作,以在点击对象时打开授权流程的网址。
setBackgroundColor(backgroundColor)TextButton设置 TextButtonStyle.FILLED 按钮的背景颜色。
setComposeAction(action, composedEmailType)TextButton设置在用户点击对象时撰写电子邮件草稿的操作。
setDisabled(disabled)TextButton设置是否停用该按钮。
setOnClickAction(action)TextButton设置在用户点击对象时执行的操作。
setOnClickOpenLinkAction(action)TextButton设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)TextButton设置在用户点击对象时打开的网址。
setText(text)TextButton设置按钮上显示的文本。
setTextButtonStyle(textButtonStyle)TextButton设置按钮样式。

详细文档

setAltText(altText)

设置按钮的替代文字,以提供无障碍功能。如果未设置,则默认为按钮上显示的文本。

参数

名称类型说明
altTextString要分配给此按钮的替代文本。

返回

TextButton - 此对象,用于实现链式连接。


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

返回

TextButton - 此对象,用于实现链式连接。


setBackgroundColor(backgroundColor)

设置 TextButtonStyle.FILLED 按钮的背景颜色。如果 TextButtonStyle.FILLED 按钮未设置,该按钮会使用插件清单中定义的次要颜色。 此方法是 TextButtonStyle.TEXT 按钮的空操作。

参数

名称类型说明
backgroundColorString#采用 RGB 格式的颜色。

返回

TextButton - 此对象,用于实现链式连接。


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一个枚举值,用于指定组合草稿是独立草稿还是回复草稿。

返回

TextButton - 此对象,用于实现链式连接。


setDisabled(disabled)

设置是否停用该按钮。已停用的按钮呈灰显状态,因此无法点击。

参数

名称类型说明
disabledBoolean停用状态。

返回

TextButton - 此对象,用于实现链式连接。


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

返回

TextButton - 此对象,用于实现链式连接。


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

返回

TextButton - 此对象,用于实现链式连接。


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

参数

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

返回

TextButton - 此对象,用于实现链式连接。


setText(text)

设置按钮上显示的文本。

参数

名称类型说明
textString按钮上显示的文字。

返回

TextButton - 此对象,用于实现链式连接。


setTextButtonStyle(textButtonStyle)

设置按钮样式。如果未设置,则默认为 TextButtonStyle.TEXT 按钮。

参数

名称类型说明
textButtonStyleTextButtonStyle按钮样式。

返回

TextButton - 此对象,用于实现链式连接。