带有文本标签的 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)
设置按钮的替代文本,以实现无障碍功能。如果未设置,则默认为按钮上显示的文字。
参数
名称 | 类型 | 说明 |
---|---|---|
altText | String | 要分配给此按钮的替代文本。 |
弃踢回攻
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);
参数
名称 | 类型 | 说明 |
---|---|---|
action | AuthorizationAction | 一个对象,用于指定点击此元素时要执行的授权操作。 |
弃踢回攻
TextButton
- 此对象,用于实现链式处理。
setBackgroundColor(backgroundColor)
设置 TextButtonStyle.FILLED
按钮的背景颜色。如果为 TextButtonStyle.FILLED
按钮未设置,该按钮将使用插件清单中定义的次要颜色。
对于 TextButtonStyle.TEXT
按钮,此方法为空操作。
参数
名称 | 类型 | 说明 |
---|---|---|
backgroundColor | String | 采用 #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(); }
参数
名称 | 类型 | 说明 |
---|---|---|
action | Action | 一个对象,用于指定点击此元素时要执行的撰写操作。 |
composedEmailType | ComposedEmailType | 一个枚举值,用于指定组合的草稿是独立草稿还是回复草稿。 |
弃踢回攻
TextButton
- 此对象,用于实现链式处理。
setDisabled(disabled)
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(); }
参数
名称 | 类型 | 说明 |
---|---|---|
action | Action | 点击此元素时要执行的操作。 |
弃踢回攻
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(); }
参数
名称 | 类型 | 说明 |
---|---|---|
action | Action | 一个对象,用于指定点击此元素时要执行的打开链接操作。 |
弃踢回攻
TextButton
- 此对象,用于实现链式处理。
setOpenLink(openLink)
设置点击对象时要打开的网址。如果网址已知且只需要打开该网址,请使用此函数。界面对象只能设置 setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
或 setComposeAction(action, composedEmailType)
中的一个。
参数
名称 | 类型 | 说明 |
---|---|---|
openLink | OpenLink | 一个 OpenLink 对象,用于描述要打开的网址。 |
弃踢回攻
TextButton
- 此对象,用于实现链式处理。
setText(text)
setTextButtonStyle(textButtonStyle)
设置按钮样式。如果未设置,则默认为 TextButtonStyle.TEXT
按钮。
参数
名称 | 类型 | 说明 |
---|---|---|
textButtonStyle | TextButtonStyle | 按钮样式。 |
弃踢回攻
TextButton
- 此对象,用于实现链式处理。