Class CardHeader

CardHeader

Card 的标头。

适用于 Google Workspace 加载项和 Google Chat 应用。

const cardHeader = CardService.newCardHeader()
                       .setTitle('Card header title')
                       .setSubtitle('Card header subtitle')
                       .setImageStyle(CardService.ImageStyle.CIRCLE)
                       .setImageUrl('https://image.png');

方法

方法	返回类型	简介
setImageAltText(imageAltText)	CardHeader	设置标题图片的替代文本。
setImageStyle(imageStyle)	CardHeader	设置卡片标题中图标的裁剪方式。
setImageUrl(imageUrl)	CardHeader	通过提供网址或数据字符串来设置要在标题中使用的图片。
setSubtitle(subtitle)	CardHeader	设置卡片标题的副标题。
setTitle(title)	CardHeader	设置卡片标题的标题。

详细文档

setImageAltText(imageAltText)

设置标题图片的替代文本。

参数

名称	类型	说明
imageAltText	String	标题图片的替代文本。

返回

CardHeader - 此对象，用于链式调用。

---

setImageStyle(imageStyle)

设置卡片标题中图标的裁剪方式。默认值为不剪裁。可选。

参数

名称	类型	说明
imageStyle	ImageStyle	样式设置。

返回

CardHeader - 此对象，用于链式调用。

---

setImageUrl(imageUrl)

通过提供网址或数据字符串来设置要在标题中使用的图片。

提供的网址可以是可公开访问的网址，也可以是 base64 编码的图片字符串。如需获取后者，您可以使用以下代码从 Google 云端硬盘中的图片创建编码后的图片字符串，然后存储该字符串以供日后与 setImageUrl(imageUrl) 搭配使用。此方法可避免插件需要访问公开提供的图片网址：

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById('123abc').getBlob().getBytes();
const encodedImageURL =
    `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;

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

参数

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

返回

CardHeader - 此对象，用于链式调用。

---

setSubtitle(subtitle)

设置卡片标题的副标题。可选。

参数

名称	类型	说明
subtitle	String	标题副标题文字。

返回

CardHeader - 此对象，用于链式调用。

---

setTitle(title)

设置卡片标题的标题。必填。

参数

名称	类型	说明
title	String	标题文字。

返回

CardHeader - 此对象，用于链式调用。