File

static final Class

File.Capabilities

Declaration of the File.Capabilities class, a class of the current user's permissions for the current file. Each permission corresponds to an action that can be taken by the user.

static final Class

File.ContentExtras

Declaration of the File.ContentExtras class, a class of additional information about file content. The additional information is optional and is not contained in the response.

static final Class

File.PictureMetadata

Declaration of the File.PictureMetadata class, a class of additional metadata of media files.

static final Class

File.VideoMetadata

Declaration of the File.VideoMetadata class, a class of additional video media metadata.

File()

Constructs a File object.

File

clone()

Clones a File object.

Map<String, String>

getAppSettings()

Obtains custom file attributes that are private to the requesting app.

File.Capabilities

getCapabilities()

Obtains the current user's permissions for the file. Each permission corresponds to an action that can be taken by the user.

String

getCategory()

Obtains the resource type.

List<String>

getContainers()

Obtains the types of space that may contain the file. The options include drive and applicationData.

String

getContentDownloadLink()

Obtains the link for downloading the file in a browser.

File.ContentExtras

getContentExtras()

Obtains additional information about file content.

String

getContentVersion()

Obtains the version number of the entity file content.

DateTime

getCreatedTime()

Obtains the time when the file or folder is created, in RFC 3339 date-time format.

String

getDescription()

Obtains the short description of the file or folder.

Boolean

getDirectlyRecycled()

Checks whether the file is directly moved to the recycle bin rather than deleted from its parent folder recursively.

Boolean

getEditedByMe()

Checks whether the file is modified by the current user.

DateTime

getEditedByMeTime()

Obtains the last time when the file is modified by the current user.

DateTime

getEditedTime()

Obtains the last time when the file or folder is modified, in RFC 3339 date-time format.

Boolean

getExistThumbnail()

Checks whether the file has a thumbnail.

Boolean

getFavorite()

Checks whether the file or folder is marked.

String

getFileName()

Obtains the name of the file or folder.

String

getFileSuffix()

Obtains the full file name extension.

String

getFullFileSuffix()

Obtains the full file name suffix extracted from the fileName field.

Boolean

getHasShared()

Checks whether the file is shared.

String

getIconDownloadLink()

Obtains the link to the icon of the file.

String

getId()

Obtains the ID of the file or folder.

Boolean

getIsAppAuthorized()

Checks whether the file is created or opened by the requesting app.

User

getLastEditor()

Obtains information about the last user who modifies the file.

String

getLastHistoryVersionId()

Obtains the latest file version ID.

String

getMimeType()

Obtains the MIME type of the file or folder.

Long

getOccupiedSpace()

Obtains the storage space occupied by the file.

String

getOnLineViewLink()

Obtains the link to preview files online in a browser.

String

getOriginalFilename()

Obtains the original file name.

Boolean

getOwnedByMe()

Checks whether the user owns the file.

List<User>

getOwners()

Obtains the users to whom the file or folder belongs.

List<String>

getParentFolder()

Obtains the parent folder ID of the file.

List<String>

getPermissionIds()

Obtains the IDs of permissions for users to access the file.

List<Permission>

getPermissions()

Obtains the list of all permissions for the file. Only the user who shares the file has the permissions, and users who access the file on the drive do not.

File.PictureMetadata

getPictureMetadata()

Obtains the additional metadata of a media file.

Map<String, String>

getProperties()

Obtains custom file attributes that are visible to all apps.

Boolean

getRecycled()

Checks whether the file or folder has been moved to the recycle bin.

DateTime

getRecycledTime()

Obtains the time when the file is moved to the recycle bin.

User

getRecyclingUser()

Obtains the user who moves the file to the recycle bin.

String

getSha256()

Obtains the SHA-256 value for verifying the file.

User

getSharer()

Obtains the user who shares the file.

DateTime

getSharedWithMeTime()

Obtains the time when the file is shared by a user.

Long

getSize()

Obtains the size of the file. The size attribute is applicable only to files.

String

getSmallThumbnailDownloadLink()

Obtains the link to the small thumbnail of the file.

String

getThumbnailDownloadLink()

Obtains the link to the thumbnail of the file.

Long

getThumbnailVersion()

Obtains the thumbnail version number.

Long

getVersion()

Obtains the increasing version number of a file.

File.VideoMetadata

getVideoMetadata()

Obtains additional video media metadata.

Boolean

getWritersHasSharePermission()

Checks whether a user who has only the write permission for the file can modify the file.

Boolean

getWriterHasCopyPermission()

Checks whether readers and commenters of the file have the copy, print, and download permissions for the file.

File

set(String fieldName, Object value)

Sets a custom attribute and its value.

File

setAppSettings(Map<String, String> appSettings)

Sets custom file attributes that are private to the requesting app.

File

setCapabilities(Capabilities capabilities)

Sets the current user's permissions for the file. Each permission corresponds to an action that can be taken by the user.

File

setCategory(String category)

Sets the resource type. The value is always drive#file.

File

setContainers(List<String> containers)

Sets the types of space that may contain the file. The options include drive and applicationData.

File

setContentDownloadLink(String contentDownloadLink)

Sets the link for downloading the file in a browser.

File

setContentExtras(ContentExtras contentExtras)

Sets additional information about file content.

File

setContentVersion(String contentVersion)

Sets the version number of the entity file content.

File

setCreatedTime(DateTime createdTime)

Sets the time when the file or folder is created, in RFC 3339 date-time format.

File

setDescription(String description)

Sets the short description of the file or folder.

File

setDirectlyRecycled(Boolean directlyRecycled)

Sets whether the file is directly moved to the recycle bin rather than deleted from its parent folder recursively.

File

setEditedByMe(Boolean editedByMe)

Sets whether the file is modified by the current user.

File

setEditedByMeTime(DateTime editedByMeTime)

Sets the last time when the file is modified by the current user, in RFC 3339 date-time format.

File

setEditedTime(DateTime editedTime)

Sets the last time when the file or folder is modified, in RFC 3339 date-time format.

File

setExistThumbnail(Boolean existThumbnail)

Sets whether the file has a thumbnail.

File

setFavorite(Boolean favorite)

Sets whether the file or folder is marked.

File

setFileName(String fileName)

Sets the name of the file or folder.

File

setFileSuffix(String fileSuffix)

Sets the full file name extension.

File

setFullFileSuffix(String fullFileSuffix)

Sets the full file name extension extracted from the fileName field.

File

setHasShared(Boolean hasShared)

Sets whether the file is shared.

File

setIconDownloadLink(String iconDownloadLink)

Sets the link to the icon of the file.

File

setId(String id)

Sets the ID of the file or folder.

File

setIsAppAuthorized(Boolean isAppAuthorized)

Sets whether the file is created or opened by the requesting app.

File

setLastEditor(User lastEditor)

Sets information about the last user who modifies the file.

File

setLastHistoryVersionId(String lastHistoryVersionId)

Sets the latest file version ID.

File

setMimeType(String mimeType)

Sets the MIME type of the file or folder.

File

setOccupiedSpace(Long occupiedSpace)

Sets the storage space occupied by the file.

File

setOnLineViewLink(String onLineViewLink)

Sets the link to preview files online in a browser.

File

setOriginalFilename(String originalFilename)

Sets the original file name.

File

setOwnedByMe(Boolean ownedByMe)

Sets whether the user owns the file.

File

setOwners(List<User> owners)

Sets the users to whom the file or folder belongs.

File

setParentFolder(List<String> parentFolder)

Sets the parent folder ID of the file.

File

setPermissionIds(List<String> permissionIds)

Sets the IDs of permissions for users to access the file.

File

setPermissions(List<Permission> permissions)

Sets the list of all permissions for the file.

File

setPictureMetadata(File.PictureMetadata pictureMetadata)

Sets the additional metadata of a media file.

File

setProperties(Map<String, String> properties)

Sets custom file attributes that are visible to all apps.

File

setRecycled(Boolean recycled)

Sets whether the file or folder has been moved to the recycle bin.

File

setRecycledTime(DateTime recycledTime)

Sets the time when a file is moved to the recycle bin, in RFC 3339 date-time format.

File

setRecyclingUser(User recyclingUser)

Sets the user who moves the file to the recycle bin.

File

setSharedWithMeTime(DateTime sharedWithMeTime)

Sets the time when the file is shared by a user, in RFC 3339 date-time format.

File

setSha256(String sha256)

Sets the SHA-256 value for verifying the file.

File

setSharer(User sharer)

Sets the user who shares the file.

File

setSize(Long size)

Sets the size of the file. The size attribute is applicable only to files.

File

setSmallThumbnailDownloadLink(String smallThumbnailDownloadLink)

Sets the link to the small thumbnail of the file. The link is set only when the requesting app has the permission to access the file content.

File

setThumbnailDownloadLink(String thumbnailDownloadLink)

Sets the link to the thumbnail of the file. The link is set only when the requesting app has the permission to access the file content.

File

setThumbnailVersion(Long thumbnailVersion)

Sets the thumbnail version number.

File

setVersion(Long version)

Sets the increasing version number of a file.

File

setVideoMetadata(File.VideoMetadata videoMetadata)

Sets additional video media metadata.

File

setWriterHasCopyPermission(Boolean writerHasCopyPermission)

Sets whether readers and commenters of the file have the copy, print, and download permissions for the file.

File

setWritersHasSharePermission(Boolean writersHasSharePermission)

Sets whether a user who has only the write permission for the file can modify the file.

File()

Constructs a File object.

public String getCategory()

Obtains the resource type.

String

Resource type. The value is always drive#file.

public File setCategory(String category)

Sets the resource type. The value is always drive#file.

category

Resource type. The value is always drive#file.

File

A File object.

public String getId()

Obtains the unique ID of the file or folder.

String

Unique ID of the file or folder.

public File setId(String id)

Sets the unique ID of the file or folder.

id

Unique ID of the file or folder.

File

A File object.

public String getFileName()

Obtains the name of the file or folder.

String

File or folder name.

public File setFileName(String fileName)

Sets the name of the file or folder.

fileName

File or folder name, which cannot contain any of the following characters:

\ / : * ? " < > |

public Long getSize()

Obtains the size of the file. The size attribute is applicable only to files.

Long

File size.

public File setSize(Long size)

Sets the size of the file. The size attribute is applicable only to files.

size

File size.

File

A File object.

public String getMimeType()

Obtains the MIME type of the file or folder.

String

MIME type of the file or folder.

public File setMimeType(String mimeType)

Sets the MIME type of the file or folder.

mimeType

MIME type of the file or folder. For details, see the MIME type of the HTTP transmission protocol.

Note: The value of mimeType is always application/vnd.huawei.apps.folder for a folder.

File

A File object.

public List<String> getParentFolder()

Obtains the parent folder ID of the file.

List<String>

IDs of the parent folders of the file.

public File setParentFolder(List<String> parentFolder)

Sets the parent folder ID of the file.

parentFolder

IDs of the parent folders of the file. The list structure is retained to ensure API compatibility. Only the first ID in the list is processed.

File

A File object.

public DateTime getCreatedTime()

Obtains the time when the file or folder is created, in RFC 3339 date-time format.

DateTime

Time when the file or folder is created, in RFC 3339 date-time format.

public File setCreatedTime(DateTime createdTime)

Sets the time when the file or folder is created, in RFC 3339 date-time format.

createdTime

Time when the file or folder is created, in RFC 3339 date-time format.

File

A File object.

public DateTime getEditedTime()

Obtains the last time when the file or folder is modified, in RFC 3339 date-time format.

DateTime

Last modification time of the file or folder, in RFC 3339 date-time format.

public File setEditedTime(DateTime editedTime)

Sets the last time when the file or folder is modified, in RFC 3339 date-time format.

editedTime

Last modification time of the file or folder, in RFC 3339 date-time format.

File

A File object.

public String getDescription()

Obtains the short description of the file or folder.

String

Short description of the file or folder.

public File setDescription(String description)

Sets the short description of the file or folder.

description

Short description of the file or folder.

File

A File object.

public List<User> getOwners()

Obtains the users to whom the file or folder belongs.

List<User>

Users to whom the file or folder belongs.

public File setOwners(List<User> owners)

Sets the users to whom the file or folder belongs.

owners

Users to whom the file or folder belongs.

File

A File object.

public Boolean getFavorite()

Checks whether the file or folder is marked.

Boolean

Sets whether the file or folder is marked.

public File setFavorite(Boolean favorite)

Sets whether the file or folder is marked.

favorite

Indicates whether the file or folder is marked. true if the file or folder is marked; false otherwise.

File

A File object.

public Boolean getRecycled()

Checks whether the file or folder has been moved to the recycle bin.

Boolean

Indicates whether the file or folder has been moved to the recycle bin.

public File setRecycled(Boolean recycled)

Sets whether the file or folder has been moved to the recycle bin.

recycled

Indicates whether the file or folder has been moved to the recycle bin.

• true: The file or folder has been moved to the recycle bin.
• false: The file or folder has not been moved to the recycle bin.

Note: Only the owner has the permission to perform this operation.

File

A File object.

public Map<String, String> getAppSettings()

Obtains custom file attributes that are private to the requesting app.

Map<String, String>

Custom file attributes.

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

Sets custom file attributes that are private to the requesting app.

appSettings

Custom file attributes. The value is a collection of key-value pairs that are private to the requesting app.

File

A File object.

public Map<String, String> getProperties()

Obtains custom file attributes that are visible to all apps.

Map<String, String>

Custom file attributes.

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

Sets custom file attributes that are visible to all apps.

properties

Custom file attributes. The value is a collection of key-value pairs that are visible to all apps.

File

A File object.

public File.Capabilities getCapabilities()

Obtains the current user's permissions for the file. Each permission corresponds to an action that can be taken by the user.

File.Capabilities

A File.Capabilities object.

public File setCapabilities(Capabilities capabilities)

Sets the current user's permissions for the file.

capabilities

Current user's permissions for the file.

File

A File object.

public File.ContentExtras getContentExtras()

Obtains additional information about file content. The additional information is optional and is not contained in the response.

File.ContentExtras

A File.ContentExtras object.

public File setContentExtras(ContentExtras contentExtras)

Sets additional information about file content.

contentExtras

Additional information about file content.

File

A File object.

public Boolean getWriterHasCopyPermission()

Checks whether readers and commenters of the file have the copy, print, and download permissions for the file.

Boolean

Whether readers and commenters of the file have the copy, print, and download permissions for the file.

• true: Readers and commenters do not have the permissions.
• false: Readers and commenters have the permissions.
• null: Whether readers and commenters have the permissions is not set.

public File setWriterHasCopyPermission(Boolean writerHasCopyPermission)

Sets whether readers and commenters of the file have the copy, print, and download permissions for the file.

writerHasCopyPermission

Indicates whether readers and commenters of the file have the copy, print, and download permissions for the file.

• true: Readers and commenters do not have the permissions.
• false: Readers and commenters have the permissions.
• null: Whether readers and commenters have the permissions is not set.

File

A File object.

public Boolean getDirectlyRecycled()

Checks whether the file is directly moved to the recycle bin rather than deleted from its parent folder recursively.

Boolean

Whether the file is directly moved to the recycle bin rather than deleted from its parent folder recursively.

• True: The file is directly moved to the recycle bin.
• false: The file is deleted from its parent folder recursively.
• null: Whether the file is directly moved to the recycle bin is not set.

public File setDirectlyRecycled(Boolean directlyRecycled)

Sets whether the file is directly moved to the recycle bin rather than deleted from its parent folder recursively.

directlyRecycled

Indicates whether the file has been explicitly moved to the recycle bin.

File

A File object.

public String getFileSuffix()

Obtains the final component of the full file name suffix. Full file name suffixes apply only to files with binary content in HUAWEI Drive Kit.

String

Final component of the full file name suffix.

public File setFileSuffix(String fileSuffix)

Sets the final component of the full file name suffix. Full file name suffixes apply only to files with binary content in HUAWEI Drive Kit.

fileSuffix

Final component of the full file name suffix.

File

A File object.

public String getFullFileSuffix()

Obtains the full file name suffix extracted from the name field. The full file name suffix may contain multiple concatenated suffixes, for example, tar.gz. Full file name suffixes apply only to files with binary content in HUAWEI Drive Kit. When the value of name changes, the full file name suffix automatically changes. If the new file name does not contain a valid file name suffix, the original full file name suffix is retained.

String

Full file name suffix. The full file name suffix may contain multiple concatenated suffixes, for example, tar.gz.

public File setFullFileSuffix(String fullFileSuffix)

Sets the full file name suffix extracted from the name field. The full file name suffix may contain multiple concatenated suffixes, for example, tar.gz. When the value of name changes, the full file name suffix automatically changes. If the new file name does not contain a valid file name suffix, the original full file name suffix is retained.

fullfileSuffix

Full file name suffix extracted from the name field. The full file name suffix may contain multiple concatenated suffixes, for example, tar.gz.

File

A File object.

public Boolean getExistThumbnail()

Checks whether the file has a thumbnail.

Boolean

Whether the file has a thumbnail.

• true: yes
• false: no

public File setExistThumbnail(Boolean existThumbnail)

Sets whether the file has a thumbnail.

existThumbnail

Indicates whether the file has a thumbnail. The value is a Boolean value.

File

A File object.

public String getIconDownloadLink()

Obtains the link to the static unauthorized icon of the file.

String

Link to the static unauthorized icon of the file.

public File setIconDownloadLink(String iconDownloadLink)

Sets the link to the icon of the file.

iconDownloadLink

Link to the icon of the file.

File

A File object.

public File.PictureMetadata getPictureMetadata()

Obtains the additional metadata of a media file.

File.PictureMetadata

Additional metadata of a media file.

public File setPictureMetadata(PictureMetadata pictureMetadata)

Sets the additional metadata of a media file.

pictureMetadata

Additional metadata of a media file.

File

A File object.

public Boolean getIsAppAuthorized()

Checks whether the file is created or opened by the requesting app.

Boolean

Whether the file is created or opened by the requesting app.

• true: yes
• false: no

public File setIsAppAuthorized(Boolean isAppAuthorized)

Sets whether the file is created or opened by the requesting app.

isAppAuthorized

Indicates whether the file is created or opened by the requesting app.

• true: yes
• false: no

File

A File object.

public User getLastEditor()

Obtains information about the last user who modifies the file.

User

Information about the last user who modifies the file.

public File setLastEditor(User lastEditor)

Sets information about the last user who modifies the file.

lastEditor

Information about the last user who modifies the file.

File

A File object.

public Boolean getEditedByMe()

Checks whether the file is modified by the current user.

Boolean

Whether the file is modified by the current user.

• true: yes
• false: no

public File setEditedByMe(Boolean editedByMe)

Sets whether the file is modified by the current user.

editedByMe

Indicates whether the file is modified by the current user.

• true: yes
• false: no

File

A File object.

public DateTime getEditedByMeTime()

Obtains the last time when the file is modified by the current user, in RFC 3339 date-time format.

DateTime

Last time when the file was modified by the current user, in RFC 3339 date-time format.

public File setEditedByMeTime(DateTime editedByMeTime)

Sets the last time when the file is modified by the current user, in RFC 3339 date-time format.

editedByMeTime

Last time when the file was modified by the current user, in RFC 3339 date-time format.

File

A File object.

public Boolean getOwnedByMe()

Checks whether the user owns the file.

Boolean

Whether the user owns the file.

public File setOwnedByMe(Boolean ownedByMe)

Sets whether the user owns the file.

ownedByMe

Indicates whether the user owns the file.

File

A File object.

public List<String> getPermissionIds()

Obtains the IDs of permissions for users to access the file.

List<String>

IDs of permissions for users to access the file.

public File setPermissionIds(List<String> permissionIds)

Sets the IDs of permissions for users to access the file.

permissionIds

IDs of permissions for users to access the file.

File

A File object.

public List<Permission> getPermissions()

Obtains the list of all permissions for the file.

List<Permission>

List of permissions for the file.

public File setPermissions(List<Permission> permissions)

Sets the list of all permissions for the file. Only the user who shares the file has the permissions, and users who access the file on the drive do not.

permissions

All permissions for the file. Only the user who shares the file has the permissions, and users who access the file on the drive do not.

File

A File object.

public Long getOccupiedSpace()

Obtains the storage space occupied by the file.

Long

Storage space occupied by the file.

public File setOccupiedSpace(Long occupiedSpace)

Sets the storage space occupied by the file.

occupiedSpace

Storage space occupied by the file.

File

A File object.

public String getSha256()

Obtains the SHA-256 value for verifying the file.

String

SHA-256 value for verifying the file.

public File setSha256(String sha256)

Sets the SHA-256 value for verifying the file.

sha256

SHA-256 value for verifying the file. This parameter may not be set on the client. If it is set, the server will use the SHA-256 value for verifying the file.

File

A File object.

public Boolean getHasShared()

Checks whether the file is shared.

Boolean

Whether the file is shared.

public File setHasShared(Boolean hasShared)

Sets whether the file is shared.

hasShared

Indicates whether the file is shared.

File

A File object.

public DateTime getSharedWithMeTime()

Obtains the time when the file is shared by a user, in RFC 3339 date-time format.

DateTime

Time when the file is shared by a user, in RFC 3339 date-time format.

public File setSharedWithMeTime(DateTime sharedWithMeTime)

Sets the time when the file is shared by a user, in RFC 3339 date-time format.

sharedWithMeTime

Time when the file is shared by a user, in RFC 3339 date-time format.

File

A File object.

public User getSharer()

Obtains the user who shares the file.

User

User who shares the file.

public File setSharer(User sharer)

Sets the user who shares the file.

sharer

User who shares the file.

File

A File object.

public List<String> getContainers()

Obtains the types of space that may contain the file.

List<String>

Types of space that may contain the file.

public File setContainers(List<String> containers)

Sets the types of space that may contain the file. The options include drive and applicationData.

containers

Types of space that may contain the file. The options include drive and applicationData.

File

A File object.

public String getThumbnailDownloadLink()

Obtains the link to the thumbnail of the file.

String

Link to the thumbnail of the file. A 0-KB file does not have a thumbnail.

public File setThumbnailDownloadLink(String thumbnailDownloadLink)

Sets the link to the thumbnail of the file. The link is set only when the requesting app has the permission to access the file content.

thumbnailDownloadLink

Link to the thumbnail of the file. The link is set only when the requesting app has the permission to access the file content.

File

A File object.

public String getSmallThumbnailDownloadLink()

Obtains the link to the small thumbnail of the file.

String

Link to the small thumbnail of the file.

public File setSmallThumbnailDownloadLink(String smallThumbnailDownloadLink)

Sets the link to the small thumbnail of the file. The link is set only when the requesting app has the permission to access the file content.

smallThumbnailDownloadLink

Link to the small thumbnail of the file. The link is set only when the requesting app has the permission to access the file content.

File

A File object.

public DateTime getRecycledTime()

Obtains the time when a file is moved to the recycle bin, in RFC 3339 date-time format.

DateTime

Time when a file is moved to the recycle bin, in RFC 3339 date-time format.

public File setRecycledTime(DateTime recycledTime)

Sets the time when a file is moved to the recycle bin, in RFC 3339 date-time format.

recycledTime

Time when a file is moved to the recycle bin, in RFC 3339 date-time format.

File

A File object.

public User getRecyclingUser()

Obtains the user who moves the file to the recycle bin.

User

User who moves the file to the recycle bin.

public File setRecyclingUser(User recyclingUser)

Sets the user who moves the file to the recycle bin.

recyclingUser

User who moves the file to the recycle bin.

File

A File object.

public File.VideoMetadata getVideoMetadata()

Obtains additional video media metadata.

File.VideoMetadata

Additional video media metadata.

public File setVideoMetadata(File.VideoMetadata videoMetadata)

Sets additional video media metadata.

videoMetadata

Additional video media metadata.

File

A File object.

public String getContentDownloadLink()

Obtains the link for downloading the file in a browser.

String

Link for downloading the file in a browser.

public File setContentDownloadLink(String contentDownloadLink)

Sets the link for downloading the file in a browser.

contentDownloadLink

Link for downloading the file in a browser.

File

A File object.

public Boolean getWritersHasSharePermission()

Checks whether a user who has only the write permission for the file can modify the file.

Boolean

Whether a user who has only the write permission for the file can modify the file.

public File setWritersHasSharePermission(Boolean writersHasSharePermission)

Sets whether a user who has only the write permission for the file can modify the file.

writersHasSharePermission

Whether a user who has only the write permission for the file can modify the file.

File

A File object.

public String getContentVersion()

Obtains the version number of the entity file content.

String

Version number of the entity file content.

public File setContentVersion(String contentVersion)

Sets the version number of the entity file content.

contentVersion