Class Attachment

附件

已弃用。此类已弃用，不应在新脚本中使用。

Google 协作平台附件，例如附加到页面的文件。

请注意，附件是 Blob，可以在需要 Blob 输入的任何位置使用。

var filesPage = SitesApp.getSite('example.com', 'mysite').getChildByName("files");
var attachments = filesPage.getAttachments();

// DocsList.createFile accepts a blob input. Since an Attachment is just a blob, we can
// just pass it directly to that method
var file = DocsList.createFile(attachments[0]);

方法

方法	返回类型	简介
getAs(contentType)	Blob	将此对象中的数据作为转换为指定内容类型的 blob 返回。
getBlob()	Blob	将此对象中的数据作为 blob 返回。

已弃用的方法

方法	返回类型	简介
deleteAttachment()	void	删除此附件。
getAttachmentType()	AttachmentType	返回该附件的类型（HOSTED 或 WEB）。
getContentType()	String	返回此附件的 MIME 类型。
getDatePublished()	Date	返回该附件的首次发布日期。
getDescription()	String	返回该附件的说明。
getLastUpdated()	Date	返回上次更新此附件的日期。
getParent()	Page	获取此附件的父页面。
getTitle()	String	返回该附件的标题。
getUrl()	String	返回该附件的下载网址。
setContentType(contentType)	Attachment	设置此附件的 MIME 类型。
setDescription(description)	Attachment	设置此附件的说明。
setFrom(blob)	Attachment	设置此附件的实际数据。
setParent(parent)	Attachment	设置此附件的父页面。
setTitle(title)	Attachment	设置此附件的标题。
setUrl(url)	Attachment	设置此附件的下载网址。

详细文档

getAs(contentType)

将此对象中的数据作为转换为指定内容类型的 blob 返回。本次 方法会为文件名添加相应的扩展名，例如“myfile.pdf”。不过， 最后一个句点之后的文件名部分（如果有）假定存在 扩展名。因此，“ShoppingList.12.25.2014”会变为 “ShoppingList.12.25.pdf”。

要查看转化次数的每日配额，请参阅 Google 配额 服务。新创建的 Google Workspace 网域可能会暂时适用更严格的条件 配额。

参数

名称	类型	说明
contentType	String	要转换为的 MIME 类型。对于大多数 blob，'application/pdf' 为 唯一有效的选项对于 BMP、GIF、JPEG 或 PNG 格式的图片，'image/bmp'、'image/gif'、'image/jpeg' 或 'image/png' 中的任何一个也 有效。对于 Google 文档，'text/markdown' 也有效。

返回

Blob - 以 blob 形式表示的数据。

---

getBlob()

将此对象中的数据作为 blob 返回。

返回

Blob - 以 blob 形式表示的数据。

已弃用的方法

deleteAttachment()

已弃用。此函数已弃用，不应在新脚本中使用。

删除此附件。

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
attachments[0].deleteAttachment();

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

getAttachmentType()

已弃用。此函数已弃用，不应在新脚本中使用。

返回该附件的类型（HOSTED 或 WEB）。

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var attType = attachments[0].getAttachmentType();

// This will log "Hosted"
Logger.log(attType);

// Since this returns an AttachmentType and not a String, for the
// purposes of equivalence we want to either do this or cast the
// type to a String
if(attType ==  SitesService.AttachmentType.HOSTED) {
  Logger.log("This is a match");
}

// The above is the same as
if(String(attType) == "Hosted") {
   Logger.log("This is also a match");
}

返回

AttachmentType - 连接类型

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

getContentType()

已弃用。此函数已弃用，不应在新脚本中使用。

返回此附件的 MIME 类型。无法发送网络附件。

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var contentType = attachments[0].getContentType();

返回

String - 附件 MIME 类型

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

getDatePublished()

已弃用。此函数已弃用，不应在新脚本中使用。

返回该附件的首次发布日期。

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var date = attachments[0].getDatePublished();

返回

Date - 原始发布日期

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

getDescription()

已弃用。此函数已弃用，不应在新脚本中使用。

返回该附件的说明。

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var description = attachments[0].getDescription();

返回

String - 附件说明

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

getLastUpdated()

已弃用。此函数已弃用，不应在新脚本中使用。

返回上次更新此附件的日期。

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var date = attachments[0].getLastUpdated();

返回

Date - 上次更新日期

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

getParent()

已弃用。此函数已弃用，不应在新脚本中使用。

获取此附件的父页面。

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();

// This is equal to pages[0]
var parent = attachments[0].getParent();

返回

Page - 父页面

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

getTitle()

已弃用。此函数已弃用，不应在新脚本中使用。

返回该附件的标题。

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var title = attachments[0].getTitle();

返回

String - 附件标题

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

getUrl()

已弃用。此函数已弃用，不应在新脚本中使用。

返回该附件的下载网址。

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var url = attachments[0].getUrl();

返回

String - 下载网址

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

setContentType(contentType)

已弃用。此函数已弃用，不应在新脚本中使用。

设置此附件的 MIME 类型。无法发送网络附件。

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
attachments[0].setContentType("text/plain");

参数

名称	类型	说明
contentType	String	新的 MIME 类型

返回

Attachment - 此用于链接的附件

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

setDescription(description)

已弃用。此函数已弃用，不应在新脚本中使用。

设置此附件的说明。

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();

// This is an example of chaining in action
attachments[0].setTitle("New Title")
              .setDescription("New Description");

参数

名称	类型	说明
description	String	新广告内容描述

返回

Attachment - 此用于链接的附件

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

setFrom(blob)

已弃用。此函数已弃用，不应在新脚本中使用。

设置此附件的实际数据。发送网络附件失败。

var pages = SitesApp.getSite('demositeappsscript').getChildren();
var attachments = pages[0].getAttachments();

// This snippet demonstrates how to create a new text blob and attach it
// to the page
var blob = Utilities.newBlob("This data is now the attachment content");

// We must set a filename since we created the blob from String data
// instead of something like a URL source
blob.setName("attachment.txt");
attachments[0].setTitle("New Title")
              .setDescription("New Description")
              .setContentType("text/plain")
              .setFrom(blob);

参数

名称	类型	说明
blob	BlobSource	新数据

返回

Attachment - 此用于链接的附件

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

setParent(parent)

已弃用。此函数已弃用，不应在新脚本中使用。

设置此附件的父页面。

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
// Sets the parent page to be the next sibling
attachments[0].setParent(pages[1]);

参数

名称	类型	说明
parent	Page	新的家长

返回

Attachment - 此用于链接的附件

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

setTitle(title)

已弃用。此函数已弃用，不应在新脚本中使用。

设置此附件的标题。

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();

// This is an example of chaining in action
attachments[0].setTitle("New Title")
              .setDescription("New Description");

参数

名称	类型	说明
title	String	新标题

返回

Attachment - 此用于链接的附件

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds

---

setUrl(url)

已弃用。此函数已弃用，不应在新脚本中使用。

设置此附件的下载网址。仅对 Web 附件有效。

var pages = SitesApp.getSite('demositeappsscript').getChildren();
var attachments = pages[0].getAttachments();

attachments[0].setTitle("New Web Attachment")
              .setDescription("New Description")
              .setUrl("http://example.com/files/your_file.txt");

参数

名称	类型	说明
url	String

返回

Attachment - 此用于链接的附件

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://sites.google.com/feeds