目录

File

Class Info

public final class File extends GenericJson

File文件元数据类。

Nested Class Summary

Qualifier and Type

Class Name and Description

static final Class

File.Capabilities

File.Capabilities类声明，当前用户对此文件的权限能力类。 每个功能都对应一个细粒度的用户可以采取的行动。

static final Class

File.ContentExtras

File.ContentExtras类声明，文件内容的附加信息（可选），响应中不会填充这些字段。

static final Class

File.PictureMetadata

File.PictureMetadata类声明，媒体类文件的附加元数据。

static final Class

File.VideoMetadata

File.VideoMetadata类声明，附加视频媒体元数据。

Public Constructor Summary

Constructor Name

File()

File类构造方法。

Public Method Summary

Qualifier and Type

Method Name and Description

File

clone()

克隆一个File类对象。

Map<String, String>

getAppSettings()

获取自定义文件属性，仅当前应用可见。

File.Capabilities

getCapabilities()

获取当前用户对此文件的权限。 每个功能都对应一个细粒度的用户可以采取的行动。

String

getCategory()

获取资源类型。

List<String>

getContainers()

获取文件的空间类型列表，当前支持'drive'和'applicationData'。

String

getContentDownloadLink()

获取文件在浏览器中的下载链接。

File.ContentExtras

getContentExtras()

获取文件内容附加信息。

String

getContentVersion()

获取实体文件内容版本号。

DateTime

getCreatedTime()

获取文件（夹）创建时间，RFC 3339 date-time。

String

getDescription()

获取文件（夹）简短描述。

Boolean

getDirectlyRecycled()

获取是否已显式地删除文件，而不是从父文件夹中递归删除。

Boolean

getEditedByMe()

获取文件是否被当前用户修改。

DateTime

getEditedByMeTime()

获取返回文件被当前用户修改的最后的时间。

DateTime

getEditedTime()

获取文件（夹）最后修改时间，RFC 3339 date-time。

Boolean

getExistThumbnail()

获取文件是否存在缩略图。

Boolean

getFavorite()

获取文件（夹）是否被标记。

String

getFileName()

获取文件（夹）名称。

String

getFileSuffix()

获取文件最后的组成部分的完整文件扩展名

String

getFullFileSuffix()

获取从fileName字段提取的完整文件扩展名。

Boolean

getHasShared()

获取文件是否被共享。

String

getIconDownloadLink()

获取文件Icon链接。

String

getId()

获取文件（夹）ID。

Boolean

getIsAppAuthorized()

获取文件是否由请求的APP创建或打开。

User

getLastEditor()

获取上一个修改该文件的用户信息。

String

getLastHistoryVersionId()

获取最近的文件版本ID。

String

getMimeType()

获取文件（夹）MIME类型。

Long

getOccupiedSpace()

获取该文件占用的存储空间。

String

getOnLineViewLink()

获取在浏览器中在线打开文档的链接。

String

getOriginalFilename()

获取原文件名称。

Boolean

getOwnedByMe()

获取当前用户是否拥有该文件。

List<User>

getOwners()

获取文件（夹）属于那些用户。

List<String>

getParentFolder()

获取当前文件父目录ID。

List<String>

getPermissionIds()

获取返回当前文件拥有的权限列表。

List<Permission>

getPermissions()

获取该文件所有的权限，只有共享该文件的用户具有权限获取这个列表，云盘里共享的文件没有。

File.PictureMetadata

getPictureMetadata()

获取媒体类文件的附加元数据。

Map<String, String>

getProperties()

获取自定义文件属性，所有应用程序可见。

Boolean

getRecycled()

获取文件（夹）是否已被删除到回收站。

DateTime

getRecycledTime()

获取文件进入回收站时间。

User

getRecyclingUser()

获取把文件放到回收站的用户。

String

getSha256()

获取校验文件内容的sha256值。

User

getSharer()

获取共享文件的用户。

DateTime

getSharedWithMeTime()

获取文件被用户共享的时间。

Long

getSize()

获取文件大小，该属性只适用于文件。

String

getSmallThumbnailDownloadLink()

获取小文件缩略图链接。

String

getThumbnailDownloadLink()

获取文件缩略图链接。

Long

getThumbnailVersion()

获取缩略图版本号。

Long

getVersion()

获取文件递增版本号。

File.VideoMetadata

getVideoMetadata()

获取附加视频媒体元数据。

Boolean

getWritersHasSharePermission()

获取只有写权限的用户是否可以修改该文件的权限。

Boolean

getWriterHasCopyPermission()

获取reader和commenter的文件拷贝、打印和下载权限。

File

set(String fieldName, Object value)

设置自定义属性及属性值。

File

setAppSettings(Map<String, String> appSettings)

设置自定义文件属性，仅当前应用可见。

File

setCapabilities(Capabilities capabilities)

设置当前用户对此文件的权限。 每个功能都对应一个细粒度的用户可以采取的行动。

File

setCategory(String category)

设置资源类型，固定值drive#file。

File

setContainers(List<String> containers)

设置包含文件的空间类型列表，当前支持'drive'，'applicationData'。

File

setContentDownloadLink(String contentDownloadLink)

设置文件在浏览器中的下载链接。

File

setContentExtras(ContentExtras contentExtras)

设置文件内容附加信息。

File

setContentVersion(String contentVersion)

设置实体文件内容版本号。

File

setCreatedTime(DateTime createdTime)

设置文件（夹）创建时间，RFC 3339 date-time。

File

setDescription(String description)

设置文件（夹）简短描述。

File

setDirectlyRecycled(Boolean directlyRecycled)

设置是否已显式地删除文件，而不是从父文件夹中递归删除。

File

setEditedByMe(Boolean editedByMe)

设置文件是否被当前用户修改。

File

setEditedByMeTime(DateTime editedByMeTime)

设置文件被当前用户修改的最后的时间，RFC 3339 date-time。

File

setEditedTime(DateTime editedTime)

设置文件（夹）最后修改时间，RFC 3339 date-time。

File

setExistThumbnail(Boolean existThumbnail)

设置文件是否存在缩略图。

File

setFavorite(Boolean favorite)

设置文件（夹）是否被标记。

File

setFileName(String fileName)

设置文件（夹）名称。

File

setFileSuffix(String fileSuffix)

设置最后的组成部分的完整文件扩展名。

File

setFullFileSuffix(String fullFileSuffix)

设置从fileName字段提取的完整文件扩展名

File

setHasShared(Boolean hasShared)

设置文件是否被分享。

File

setIconDownloadLink(String iconDownloadLink)

设置文件Icon链接。

File

setId(String id)

设置文件（夹）ID。

File

setIsAppAuthorized(Boolean isAppAuthorized)

设置文件是否由请求的APP创建或打开。

File

setLastEditor(User lastEditor)

设置最后一个修改文件的用户。

File

setLastHistoryVersionId(String lastHistoryVersionId)

设置最近的文件版本ID。

File

setMimeType(String mimeType)

设置文件（夹）MIME类型。

File

setOccupiedSpace(Long occupiedSpace)

设置文件占用的存储空间。

File

setOnLineViewLink(String onLineViewLink)

设置在浏览器中在线打开文档的链接。

File

setOriginalFilename(String originalFilename)

设置原文件名称。

File

setOwnedByMe(Boolean ownedByMe)

设置当前用户是否拥有该文件。

File

setOwners(List<User> owners)

设置文件（夹）属于那些用户。

File

setParentFolder(List<String> parentFolder)

设置当前文件父目录ID。

File

setPermissionIds(List<String> permissionIds)

设置当前文件拥有的权限列表。

File

setPermissions(List<Permission> permissions)

设置文件的所有权限列表。

File

setPictureMetadata(File.PictureMetadata pictureMetadata)

设置媒体类文件的附加元数据。

File

setProperties(Map<String, String> properties)

设置自定义文件属性，所有应用程序可见。

File

setRecycled(Boolean recycled)

设置文件（夹）是否已被删除到回收站。

File

setRecycledTime(DateTime recycledTime)

设置文件进入回收站时间，RFC 3339 date-time。

File

setRecyclingUser(User recyclingUser)

设置把文件放到回收站的用户。

File

setSharedWithMeTime(DateTime sharedWithMeTime)

设置文件被用户共享的时间，RFC 3339 date-time。

File

setSha256(String sha256)

设置用于校验文件内容的sha256值。

File

setSharer(User sharer)

设置共享文件的用户。

File

setSize(Long size)

设置文件大小，该属性只适用于文件。

File

setSmallThumbnailDownloadLink(String smallThumbnailDownloadLink)

设置小文件缩略图链接，当三方应用程序有权限访问文件内容时设置。

File

setThumbnailDownloadLink(String thumbnailDownloadLink)

设置文件缩略图链接，当三方应用程序有权限访问文件内容时设置。

File

setThumbnailVersion(Long thumbnailVersion)

设置缩略图版本号。

File

setVersion(Long version)

设置文件递增版本号。

File

setVideoMetadata(File.VideoMetadata videoMetadata)

设置附加视频媒体元数据。

File

setWriterHasCopyPermission(Boolean writerHasCopyPermission)

设置reader和commenter的文件拷贝、打印和下载权限。

File

setWritersHasSharePermission(Boolean writersHasSharePermission)

设置只有写权限的用户是否可以修改该文件的权限。

Public Constructors

[h2]File

Constructor

File()

构造一个File类对象。

Public Methods

[h2]getCategory

Method

public String getCategory()

获取资源类型。

Returns

Type

Description

String

资源类型，固定值drive#file。

[h2]setCategory

Method

public File setCategory(String category)

设置资源类型，固定值drive#file。

Parameters

Name

Description

category

资源类型，固定值drive#file。

Returns

Type

Description

File

返回一个File对象。

[h2]getId

Method

public String getId()

获取文件（夹）唯一标识。

Returns

Type

Description

String

获取文件（夹）唯一标识。

[h2]setId

Method

public File setId(String id)

设置文件（夹）唯一标识。

Parameters

Name

Description

id

文件（夹）唯一标识。

Returns

Type

Description

File

返回一个File对象。

[h2]getFileName

Method

public String getFileName()

获取文件（夹）名称。

Returns

Type

Description

String

文件（夹）名称。

[h2]setFileName

Method

public File setFileName(String fileName)

设置文件（夹）名称。

Parameters

Name

Description

fileName

文件（夹）名称，文件名不能包含下列任何字符：

\ / : * ? " < > |。

Returns

Type

Description

File

返回一个File对象。

[h2]getSize

Method

public Long getSize()

获取文件大小，该属性只适用于文件。

Returns

Type

Description

Long

文件大小。

[h2]setSize

Method

public File setSize(Long size)

设置文件大小，该属性只适用于文件。

Parameters

Name

Description

size

文件大小。

Returns

Type

Description

File

返回一个File对象。

[h2]getMimeType

Method

public String getMimeType()

获取文件（夹）MIME类型。

Returns

Type

Description

String

文件（夹）MIME类型。

[h2]setMimeType

Method

public File setMimeType(String mimeType)

设置文件（夹）MIME类型。

Parameters

Name

Description

mimeType

文件内容类型，取值参考标准HTTP传输协议MIME类型；

注：创建文件目录时，mimeType取固定值为"application/vnd.huawei.apps.folder"。

Returns

Type

Description

File

返回一个File对象。

[h2]getParentFolder

Method

public List<String> getParentFolder()

获取当前文件父目录ID。

Returns

Type

Description

List<String>

文件父目录ID列表。

[h2]setParentFolder

Method

public File setParentFolder(List<String> parentFolder)

设置当前文件父目录ID。

Parameters

Name

Description

parentFolder

父目录的ID，保证接口兼容性，保留List结构，只需要处理列表第一个值。

Returns

Type

Description

File

返回一个File对象。

[h2]getCreatedTime

Method

public DateTime getCreatedTime()

获取文件（夹）创建时间，RFC 3339 date-time。

Returns

Type

Description

DateTime

文件（夹）创建时间，RFC 3339 date-time。

[h2]setCreatedTime

Method

public File setCreatedTime(DateTime createdTime)

设置文件（夹）创建时间，RFC 3339 date-time。

Parameters

Name

Description

createdTime

文件（夹）创建时间，RFC 3339 date-time。

Returns

Type

Description

File

返回一个File对象。

[h2]getEditedTime

Method

public DateTime getEditedTime()

获取文件（夹）最后修改时间，RFC 3339 date-time。

Returns

Type

Description

DateTime

文件（夹）最后修改时间，RFC 3339 date-time。

[h2]setEditedTime

Method

public File setEditedTime(DateTime editedTime)

设置文件（夹）最后修改时间，RFC 3339 date-time。

Parameters

Name

Description

editedTime

文件（夹）最后修改时间，RFC 3339 date-time。

Returns

Type

Description

File

返回一个File对象。

[h2]getDescription

Method

public String getDescription()

获取文件（夹）简短描述。

Returns

Type

Description

String

文件（夹）简短描述。

[h2]setDescription

Method

public File setDescription(String description)

设置文件（夹）简短描述。

Parameters

Name

Description

description

文件（夹）简短描述。

Returns

Type

Description

File

返回一个File对象。

[h2]getOwners

Method

public List<User> getOwners()

获取文件（夹）属于哪些用户。

Returns

Type

Description

List<User>

文件（夹）属于哪些用户。

[h2]setOwners

Method

public File setOwners(List<User> owners)

设置文件（夹）属于哪些用户。

Parameters

Name

Description

owners

文件（夹）属于哪些用户。

Returns

Type

Description

File

返回一个File对象。

[h2]getFavorite

Method

public Boolean getFavorite()

获取文件（夹）是否被标记。

Returns

Type

Description

Boolean

文件（夹）是否被标记。

[h2]setFavorite

Method

public File setFavorite(Boolean favorite)

设置文件（夹）是否被标记。

Parameters

Name

Description

favorite

对文件标记（true：标记，false：取消标记）。

Returns

Type

Description

File

返回一个File对象。

[h2]getRecycled

Method

public Boolean getRecycled()

获取文件（夹）是否已被删除到回收站。

Returns

Type

Description

Boolean

文件（夹）是否已被删除到回收站。

[h2]setRecycled

Method

public File setRecycled(Boolean recycled)

设置文件（夹）是否已被删除到回收站。

Parameters

Name

Description

recycled

文件（夹）是否已被删除到回收站。

  • true：删除到回收站。
  • false：从回收站移除。

注：只有Owner有权操作。

Returns

Type

Description

File

返回一个File对象。

[h2]getAppSettings

Method

public Map<String, String> getAppSettings()

获取自定义文件属性，仅当前应用可见。

Returns

Type

Description

Map<String, String>

自定义文件属性。

[h2]setAppSettings

Method

public File setAppSettings(Map<String, String> appSettings)

设置自定义文件属性，仅当前应用可见。

Parameters

Name

Description

appSettings

自定义文件属性，key-value集合，对当前应用程序是私有的。

Returns

Type

Description

File

返回一个File对象。

[h2]getProperties

Method

public Map<String, String> getProperties()

获取自定义文件属性，所有应用程序可见。

Returns

Type

Description

Map<String, String>

自定义文件属性。

[h2]setProperties

Method

public File setProperties(Map<String, String> properties)

设置自定义文件属性，所有应用程序可见。

Parameters

Name

Description

properties

自定义文件属性，key-value集合，对所有应用程序是可见的。

Returns

Type

Description

File

返回一个File对象。

[h2]getCapabilities

Method

public File.Capabilities getCapabilities()

获取当前用户对此文件的权限。 每个功能都对应一个细粒度的用户可以采取的行动。

Returns

Type

Description

File.Capabilities

返回一个File.Capabilities对象。

[h2]setCapabilities

Method

public File setCapabilities(Capabilities capabilities)

设置当前用户对该文件的使用权限。

Parameters

Name

Description

capabilities

用户对文件的使用权限。

Returns

Type

Description

File

返回一个File对象。

[h2]getContentExtras

Method

public File.ContentExtras getContentExtras()

获取文件内容附加信息（可选），响应中不会填充这些字段。

Returns

Type

Description

File.ContentExtras

返回一个File.ContentExtras对象。

[h2]setContentExtras

Method

public File setContentExtras(ContentExtras contentExtras)

设置文件内容的附加信息。

Parameters

Name

Description

contentExtras

文件内容的附加信息。

Returns

Type

Description

File

返回一个File对象。

[h2]getWriterHasCopyPermission

Method

public Boolean getWriterHasCopyPermission()

获取reader和commenter的文件拷贝、打印和下载权限。

Returns

Type

Description

Boolean

reader和commenter的文件拷贝、打印和下载权限。

  • true：禁止拷贝、打印和下载文件。
  • false：允许拷贝、打印和下载文件。
  • null：未设置。

[h2]setWriterHasCopyPermission

Method

public File setWriterHasCopyPermission(Boolean writerHasCopyPermission)

设置reader和commenter的文件拷贝、打印和下载权限。

Parameters

Name

Description

writerHasCopyPermission

reader和commenter是否有文件拷贝、打印和下载权限。

  • true：禁止拷贝、打印和下载文件。
  • false：允许拷贝、打印和下载文件
  • null：未设置。

Returns

Type

Description

File

返回一个File对象。

[h2]getDirectlyRecycled

Method

public Boolean getDirectlyRecycled()

获取是否已显式地删除文件，而不是从父文件夹中递归删除。

Returns

Type

Description

Boolean

是否已显式地删除文件，而不是从父文件夹中递归删除。

  • true：已显示的删除。
  • false：从父文件夹中递归删除。
  • null：未设置。

[h2]setDirectlyRecycled

Method

public File setDirectlyRecycled(Boolean directlyRecycled)

设置是否已显式地删除文件，而不是从父文件夹中递归删除。

Parameters

Name

Description

directlyRecycled

是否已显式地删除文件。

Returns

Type

Description

File

返回一个File对象。

[h2]getFileSuffix

Method

public String getFileSuffix()

获取最后的组成部分的完整文件扩展名，fullFileSuffix的最终内容。仅适用于HuaweiDrive中具有二进制内容的文件。

Returns

Type

Description

String

最后的组成部分的完整扩展名，fullFileSuffix的最终内容。

[h2]setFileSuffix

Method

public File setFileSuffix(String fileSuffix)

设置最后的组成部分的完整文件扩展名，fullFileSuffix的最终内容。仅适用于HuaweiDrive中具有二进制内容的文件。

Parameters

Name

Description

fileSuffix

最后的组成部分的完整文件扩展名，fullFileSuffix的最终内容。

Returns

Type

Description

File

返回一个File对象。

[h2]getFullFileSuffix

Method

public String getFullFileSuffix()

获取从名称字段提取的完整文件扩展名。可能包含多个串联的扩展名，例如“ tar.gz”。仅适用于HuaweiDrive中具有二进制内容的文件。 当名称字段更改时，它将自动更新，但是如果新名称不包含有效的扩展名，则不会清除该更新。

Returns

Type

Description

String

返回完整的文件扩展名。可能包含多个串联的扩展名，例如“ tar.gz”。

[h2]setFullFileSuffix

Method

public File setFullFileSuffix(String fullFileSuffix)

设置从名称字段提取的完整文件扩展名。可能包含多个串联的扩展名，例如“ tar.gz”。当名称字段更改时，它将自动更新，但是如果新名称不包含有效的扩展名，则不会清除该更新。

Parameters

Name

Description

fullfileSuffix

从名称字段提取的完整文件扩展名。可能包含多个串联的扩展名，例如“ tar.gz”。

Returns

Type

Description

File

返回一个File对象。

[h2]getExistThumbnail

Method

public Boolean getExistThumbnail()

获取是否包含缩略图。

Returns

Type

Description

Boolean

是否包含缩略图。

  • true：包含
  • false：不包含

[h2]setExistThumbnail

Method

public File setExistThumbnail(Boolean existThumbnail)

设置文件是否存在缩略图。

Parameters

Name

Description

existThumbnail

布尔值，文件是否存在缩略图。

Returns

Type

Description

File

返回一个File对象。

[h2]getIconDownloadLink

Method

public String getIconDownloadLink()

获取一个静态的未经认证的文件图标链接。

Returns

Type

Description

String

未经认证的文件图标链接。

[h2]setIconDownloadLink

Method

public File setIconDownloadLink(String iconDownloadLink)

设置文件Icon链接。

Parameters

Name

Description

iconDownloadLink

文件Icon链接。

Returns

Type

Description

File

返回一个File对象。

[h2]getPictureMetadata

Method

public File.PictureMetadata getPictureMetadata()

获取媒体类文件的附加元数据。

Returns

Type

Description

File.PictureMetadata

媒体类文件的附加元数据。

[h2]setPictureMetadata

Method

public File setPictureMetadata(PictureMetadata pictureMetadata)

设置媒体类文件的附加元数据。

Parameters

Name

Description

pictureMetadata

媒体类文件的附加元数据。

Returns

Type

Description

File

返回一个File对象。

[h2]getIsAppAuthorized

Method

public Boolean getIsAppAuthorized()

获取文件是否由请求的APP创建或打开。

Returns

Type

Description

Boolean

是否由请求的App创建或打开。

  • true：是
  • false：否

[h2]setIsAppAuthorized

Method

public File setIsAppAuthorized(Boolean isAppAuthorized)

设置文件是否由请求的APP创建或打开。

Parameters

Name

Description

isAppAuthorized

文件是否由请求的App创建或打开。

  • true：是
  • false：不是

Returns

Type

Description

File

返回一个File对象。

[h2]getLastEditor

Method

public User getLastEditor()

获取上一个修改的用户信息。

Returns

Type

Description

User

上一个修改的用户的信息。

[h2]setLastEditor

Method

public File setLastEditor(User lastEditor)

设置最后一个修改文件的用户。

Parameters

Name

Description

lastEditor

最后一个修改文件的用户信息。

Returns

Type

Description

File

返回一个File对象。

[h2]getEditedByMe

Method

public Boolean getEditedByMe()

获取是否为当前用户修改。

Returns

Type

Description

Boolean

是否为当前用户修改。

  • true：是
  • false：否

[h2]setEditedByMe

Method

public File setEditedByMe(Boolean editedByMe)

设置文件是否被当前用户修改。

Parameters

Name

Description

editedByMe

文件是否被当前用户修改。

  • true：是
  • false：不是

Returns

Type

Description

File

返回一个File对象。

[h2]getEditedByMeTime

Method

public DateTime getEditedByMeTime()

获取文件被当前用户修改的最后的时间，RFC 3339 date-time。

Returns

Type

Description

DateTime

文件被当前用户修改的最后的时间，RFC 3339 date-time。

[h2]setEditedByMeTime

Method

public File setEditedByMeTime(DateTime editedByMeTime)

设置文件被当前用户修改的最后的时间，RFC 3339 date-time。

Parameters

Name

Description

editedByMeTime

文件被当前用户修改的最后的时间，RFC 3339 date-time。

Returns

Type

Description

File

返回一个File对象。

[h2]getOwnedByMe

Method

public Boolean getOwnedByMe()

获取用户是否拥有该文件。

Returns

Type

Description

Boolean

用户是否拥有该文件。

[h2]setOwnedByMe

Method

public File setOwnedByMe(Boolean ownedByMe)

设置当前用户是否拥有该文件。

Parameters

Name

Description

ownedByMe

当前用户是否拥有该文件。

Returns

Type

Description

File

返回一个File对象。

[h2]getPermissionIds

Method

public List<String> getPermissionIds()

获取访问此文件的用户的权限ID列表。

Returns

Type

Description

List<String>

访问此文件的用户的权限ID列表。

[h2]setPermissionIds

Method

public File setPermissionIds(List<String> permissionIds)

设置当前文件拥有的权限列表。

Parameters

Name

Description

permissionIds

当前文件拥有的权限列表。

Returns

Type

Description

File

返回一个File对象。

[h2]getPermissions

Method

public List<Permission> getPermissions()

获取文件的所有权限列表。

Returns

Type

Description

List<Permission>

文件的所有权限列表。

[h2]setPermissions

Method

public File setPermissions(List<Permission> permissions)

设置该文件所有的权限，只有共享文件的用户具有权限，云盘里共享的文件没有。

Parameters

Name

Description

permissions

该文件所有的权限，只有共享文件的用户具有权限，云盘里共享的文件没有。

Returns

Type

Description

File

返回一个File对象。

[h2]getOccupiedSpace

Method

public Long getOccupiedSpace()

获取文件占用的存储空间，与文件大小有差别。

Returns

Type

Description

Long

该文件占用的存储空间。

[h2]setOccupiedSpace

Method

public File setOccupiedSpace(Long occupiedSpace)

设置文件占用的存储空间。

Parameters

Name

Description

occupiedSpace

该文件占用的存储空间。

Returns

Type

Description

File

返回一个File对象。

[h2]getSha256

Method

public String getSha256()

获取用于校验文件内容的sha256值。

Returns

Type

Description

String

返回用于校验文件内容的sha256值。

[h2]setSha256

Method

public File setSha256(String sha256)

设置用于校验文件内容的sha256值。

Parameters

Name

Description

sha256

用于校验文件内容的sha256值。客户端可以不设置该属性值，如果客户端设置该属性值，服务器将对上传文件内容做sha256值校验。

Returns

Type

Description

File

返回一个File对象。

[h2]getHasShared

Method

public Boolean getHasShared()

获取文件是否已共享。

Returns

Type

Description

Boolean

文件是否已共享。

[h2]setHasShared

Method

public File setHasShared(Boolean hasShared)

设置文件是否被共享。

Parameters

Name

Description

hasShared

文件是否被共享。

Returns

Type

Description

File

返回一个File对象。

[h2]getSharedWithMeTime

Method

public DateTime getSharedWithMeTime()

获取用户共享文件的时间，RFC 3339 date-time。

Returns

Type

Description

DateTime

用户共享文件的时间，RFC 3339 date-time。

[h2]setSharedWithMeTime

Method

public File setSharedWithMeTime(DateTime sharedWithMeTime)

设置文件被用户共享的时间，RFC 3339 date-time。

Parameters

Name

Description

sharedWithMeTime

文件被用户共享的时间，RFC 3339 date-time。

Returns

Type

Description

File

返回一个File对象。

[h2]getSharer

Method

public User getSharer()

获取共享文件的用户。

Returns

Type

Description

User

共享文件的用户。

[h2]setSharer

Method

public File setSharer(User sharer)

设置共享文件的用户。

Parameters

Name

Description

sharer

共享文件的用户。

Returns

Type

Description

File

返回一个File对象。

[h2]getContainers

Method

public List<String> getContainers()

获取包含文件的空间类型列表。

Returns

Type

Description

List<String>

包含文件的空间类型列表。

[h2]setContainers

Method

public File setContainers(List<String> containers)

设置包含文件的空间类型列表，当前支持'drive'，'applicationData’。

Parameters

Name

Description

containers

包含文件的空间类型列表，当前支持'drive'，'applicationData'。

Returns

Type

Description

File

返回一个File对象。

[h2]getThumbnailDownloadLink

Method

public String getThumbnailDownloadLink()

获取文件缩略图链接地址。

Returns

Type

Description

String

文件缩略图链接地址（0KB文件没有缩略图）。

[h2]setThumbnailDownloadLink

Method

public File setThumbnailDownloadLink(String thumbnailDownloadLink)

设置文件缩略图链接，当三方应用程序有权限访问文件内容时设置。

Parameters

Name

Description

thumbnailDownloadLink

文件缩略图链接，当三方应用程序有权限访问文件内容时设置。

Returns

Type

Description

File

返回一个File对象。

[h2]getSmallThumbnailDownloadLink

Method

public String getSmallThumbnailDownloadLink()

获取小文件缩略图链接地址。

Returns

Type

Description

String

小文件缩略图链接地址。

[h2]setSmallThumbnailDownloadLink

Method

public File setSmallThumbnailDownloadLink(String smallThumbnailDownloadLink)

设置小文件缩略图链接，当三方应用程序有权限访问文件内容时设置。

Parameters

Name

Description

smallThumbnailDownloadLink

小文件缩略图链接，当三方应用程序有权限访问文件内容时设置。

Returns

Type

Description

File

返回一个File对象。

[h2]getRecycledTime

Method

public DateTime getRecycledTime()

获取文件进入回收站的时间，RFC 3339 date-time。

Returns

Type

Description

DateTime

文件进入回收站的时间，RFC 3339 date-time。

[h2]setRecycledTime

Method

public File setRecycledTime(DateTime recycledTime)

设置文件进入回收站时间，RFC 3339 date-time。

Parameters

Name

Description

recycledTime

文件进入回收站时间，RFC 3339 date-time。

Returns

Type

Description

File

返回一个File对象。

[h2]getRecyclingUser

Method

public User getRecyclingUser()

获取把文件放到回收站的用户。

Returns

Type

Description

User

返回将文件放到回收站的用户。

[h2]setRecyclingUser

Method

public File setRecyclingUser(User recyclingUser)

设置把文件放到回收站的用户。

Parameters

Name

Description

recyclingUser

把文件放到回收站的用户。

Returns

Type

Description

File

返回一个File对象。

[h2]getVideoMetadata

Method

public File.VideoMetadata getVideoMetadata()

获取附加视频媒体元数据。

Returns

Type

Description

File.VideoMetadata

附加视频媒体元数据。

[h2]setVideoMetadata

Method

public File setVideoMetadata(File.VideoMetadata videoMetadata)

设置附加视频媒体元数据。

Parameters

Name

Description

videoMetadata

附加视频媒体元数据。

Returns

Type

Description

File

返回一个File对象。

[h2]getContentDownloadLink

Method

public String getContentDownloadLink()

获取文件在浏览器中的下载链接。

Returns

Type

Description

String

文件在浏览器中的下载链接。

[h2]setContentDownloadLink

Method

public File setContentDownloadLink(String contentDownloadLink)

设置文件在浏览器中的下载链接。

Parameters

Name

Description

contentDownloadLink

文件在浏览器中的下载链接。

Returns

Type

Description

File

返回一个File对象。

[h2]getWritersHasSharePermission

Method

public Boolean getWritersHasSharePermission()

获取只有写权限的用户是否可以修改该文件的权限。

Returns

Type

Description

Boolean

只有写权限的用户是否可以修改该文件的权限。

[h2]setWritersHasSharePermission

Method

public File setWritersHasSharePermission(Boolean writersHasSharePermission)

设置只有写权限的用户是否可以修改该文件的权限。

Parameters

Name

Description

writersHasSharePermission

只有写权限的用户是否可以修改该文件的权限。

Returns

Type

Description

File

返回一个File对象。

[h2]getContentVersion

Method

public String getContentVersion()

获取实体文件内容版本号。

Returns

Type

Description

String

实体文件内容版本号。

[h2]setContentVersion

Method

public File setContentVersion(String contentVersion)

设置实体文件内容版本号。

Parameters

Name

Description

contentVersion

实体文件内容版本号。

Returns

Type

Description

File

返回一个File对象。

[h2]getLastHistoryVersionId

Method

public String getLastHistoryVersionId()

获取最近的文件版本ID。

Returns

Type

Description

String

返回最近的文件版本ID。

[h2]setLastHistoryVersionId

Method

public File setLastHistoryVersionId(String lastHistoryVersionId)

设置最近的文件版本ID。

Parameters

Name

Description

lastHistoryVersionId

最近的文件版本ID。

Returns

Type

Description

File

返回一个File对象。

[h2]getOriginalFilename

Method

public String getOriginalFilename()

获取原文件名称。

Returns

Type

Description

String

返回原文件名称。

[h2]setOriginalFilename

Method

public File setOriginalFilename(String originalFilename)

设置原文件名称。

Parameters

Name

Description

originalFilename

原文件名称。

Returns

Type

Description

File

返回一个File对象。

[h2]getThumbnailVersion

Method

public Long getThumbnailVersion()

获取缩略图版本号。

Returns

Type

Description

Long

返回缩略图版本号。

[h2]setThumbnailVersion

Method

public File setThumbnailVersion(Long thumbnailVersion)

设置缩略图版本号。

Parameters

Name

Description

thumbnailVersion

缩略图版本号。

Returns

Type

Description

File

返回一个File对象。

[h2]getVersion

Method

public Long getVersion()

获取文件递增版本号。

Returns

Type

Description

Long

返回文件递增版本号。

[h2]setVersion

Method

public File setVersion(Long version)

设置文件递增版本号。

Parameters

Name

Description

version

文件递增版本号。

Returns

Type

Description

File

返回一个File对象。

[h2]getOnLineViewLink

Method

public String getOnLineViewLink()

获取在浏览器中在线打开文档的链接。

Returns

Type

Description

String

返回在浏览器中在线打开文档的链接。

[h2]setOnLineViewLink

Method

public File setOnLineViewLink(String onLineViewLink)

设置在浏览器中在线打开文档的链接。

Parameters

Name

Description

onLineViewLink

在浏览器中在线打开文档的链接。

Returns

Type

Description

File

返回一个File对象。

[h2]set

Method

public File set(String fieldName, Object value)

设置自定义属性及属性值。

Parameters

Name

Description

fieldName

属性名称。

value

属性值。

Returns

Type

Description

File

返回一个File对象。

[h2]clone

Method

public File clone()

克隆一个File类对象。

Returns

Type

Description

File

返回一个File对象。