Class Image

图片

显示单张图片的微件。

var image = CardService.newImage().setAltText("A nice image").setImageUrl("https://image.png");

方法

方法返回类型简介
setAltText(altText)Image设置图片的替代文字,以确保可访问性。
setAuthorizationAction(action)Image设置一项授权操作,以在点击对象时打开授权流程的网址。
setComposeAction(action, composedEmailType)Image设置在用户点击对象时撰写电子邮件草稿的操作。
setImageUrl(url)Image通过提供图片的网址或数据字符串,设置要使用的图片。
setOnClickAction(action)Image设置在用户点击对象时执行的操作。
setOnClickOpenLinkAction(action)Image设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)Image设置在用户点击对象时打开的网址。

详细文档

setAltText(altText)

设置图片的替代文字,以确保可访问性。必需。

参数

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

返回

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


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

返回

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


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

返回

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


setImageUrl(url)

通过提供图片的网址或数据字符串,设置要使用的图片。必需。

提供的网址可以是可公开访问的网址,也可以是 base64 编码的图片字符串。 若想获取后者,您可以使用以下代码基于 Google 云端硬盘中的图片创建编码后的图片字符串,然后存储该字符串以供日后与 setImageUrl(url) 搭配使用。使用此方法时,插件无需访问公开提供的图片网址:

// The following assumes you have the image to use in Google Drive and have its ID.
var imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes();
var encodedImageURL = "data:image/jpeg;base64," + Utilities.base64Encode(imageBytes);

// You can store encodeImageURL and use it as a parameter to Image.setImageUrl(url).

参数

名称类型说明
urlString要使用的托管图片的网址,或编码图片字符串。

返回

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


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

返回

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


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

返回

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


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

参数

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

返回

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