此页面由 Cloud Translation API 翻译。

Class ImageButton

包含图片的 ImageButton。

var imageButton = CardService.newImageButton()
    .setAltText("An image button with an airplane icon.")
    .setIcon(CardService.Icon.AIRPLANE)
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://airplane.com"));

方法

方法	返回类型	简介
`setAltText(altText)`	`ImageButton`	设置按钮的替代文字，以提供无障碍功能。
`setAuthorizationAction(action)`	`ImageButton`	设置一项授权操作，以在点击对象时打开授权流程的网址。
`setComposeAction(action, composedEmailType)`	`ImageButton`	设置在用户点击对象时撰写电子邮件草稿的操作。
`setIcon(icon)`	`ImageButton`	设置要在按钮上显示的预定义 `Icon`。
`setIconUrl(url)`	`ImageButton`	设置用作此按钮图标的图片的网址。
`setOnClickAction(action)`	`ImageButton`	设置在用户点击对象时执行的操作。
`setOnClickOpenLinkAction(action)`	`ImageButton`	设置在用户点击对象时在标签页中打开网址的操作。
`setOpenLink(openLink)`	`ImageButton`	设置在用户点击对象时打开的网址。

详细文档

`setAltText(altText)`

设置按钮的替代文字，以提供无障碍功能。必需。

参数

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

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

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

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

`setComposeAction(action, composedEmailType)`

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

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

注意：此方法不会设置用于扩展 Compose 界面的组合操作。相反，此方法会将此界面元素连接到 Action，用于在 Apps 脚本中撰写草稿消息，并在操作完成后在 Gmail 中打开。

// ...

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

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

`setIcon(icon)`

设置要在按钮上显示的预定义 Icon。必须使用此值或 setIconUrl(url) 来定义按钮图片。

参数

名称	类型	说明
`icon`	`Icon`	其中一个预定义的 `Icon` 值。

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

`setIconUrl(url)`

设置用作此按钮图标的图片的网址。必须使用此值或 setIcon(icon) 来定义按钮图片。

参数

名称	类型	说明
`url`	`String`	用作此按钮的图标的托管图片的网址。

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

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

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

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

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

`setOpenLink(openLink)`

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

参数

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

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