Class Image

图片

显示单张图片的 widget。如需了解如何剪裁图片，请参阅 ImageCropStyle。

适用于 Google Workspace 插件和 Google Chat 应用。 

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 对象。

<ph type="x-smartling-placeholder"> 

// ...

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 编码的图片字符串。 要获得后者，您可以使用以下代码，根据 图片，然后存储该字符串，以便日后与 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)。

参数

名称类型说明
openLinkOpenLink描述要打开的网址的 OpenLink 对象。

返回

Image - 此对象，用于链接。