Metadata

public abstract class Metadata extends Object
implements Freezable<Metadata>

The details of a Drive file or folder.

Constant Summary

int	CONTENT_AVAILABLE_LOCALLY	The content is available on the device.
int	CONTENT_NOT_AVAILABLE_LOCALLY	The content is not available on the device.

Public Constructor Summary

Metadata()

Public Method Summary

String	getAlternateLink() Returns a link for opening the file using a relevant Google editor or viewer.
int	getContentAvailability() Returns `CONTENT_NOT_AVAILABLE_LOCALLY` when the content is not available on the device or `CONTENT_AVAILABLE_LOCALLY` when the content is available on the device.
Date	getCreatedDate() Returns the create time for this resource.
Map<CustomPropertyKey, String>	getCustomProperties() Gets all custom properties and their associated values.
String	getDescription() A short description of the resource.
DriveId	getDriveId() Returns the id of the resource
String	getEmbedLink() A link for embedding the file.
String	getFileExtension() The file extension used when downloading this file.
long	getFileSize() The size of the file in bytes.
Date	getLastViewedByMeDate() Returns the last time this resource was viewed by the user or `null` if the user never viewed this resource.
String	getMimeType() Returns the MIME type of the resource
Date	getModifiedByMeDate() Returns the last time this resource was modified by the user or `null` if the user never modified this resource.
Date	getModifiedDate() Returns the last time this resource was modified by anyone.
String	getOriginalFilename() The original filename if the file was uploaded manually, or the original title if the file was inserted through the API.
long	getQuotaBytesUsed() The number of quota bytes used by this file.
Date	getSharedWithMeDate() Returns the time at which this resource was shared with the user or `null` if the user is the owner of this resource.
String	getTitle() Returns the title of the resource
String	getWebContentLink() A link for downloading the content of the file in a browser using cookie based authentication.
String	getWebViewLink() A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
boolean	isEditable() Returns true if this resource can be edited by the current user.
boolean	isExplicitlyTrashed() Returns true if this resource has been explicitly trashed, as opposed to recursively trashed.
boolean	isFolder() Returns true if this Metadata is for a folder.
boolean	isInAppFolder() Returns true if this resource is in the Application Folder.
boolean	isPinnable() Returns true if the resource can be pinned.
boolean	isPinned() Returns true if this resource has been pinned (a request has been made to make the content available offline).
boolean	isRestricted() Whether viewers are prevented from downloading this file.
boolean	isShared() Returns true if this resource is a shared resource.
boolean	isStarred() Returns true if this resource is starred by the user.
boolean	isTrashable() Returns true if this resource can be trashed by this user.
boolean	isTrashed() Returns true if this resource has been trashed.
boolean	isViewed() Whether this file has been viewed by this user.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface com.google.android.gms.common.data.Freezable

abstract Metadata	freeze() Freeze a volatile representation into an immutable representation.
abstract boolean	isDataValid() Check to see if this object is valid for use.

Constants

public static final int CONTENT_AVAILABLE_LOCALLY

The content is available on the device.

Constant Value: 1

public static final int CONTENT_NOT_AVAILABLE_LOCALLY

The content is not available on the device.

Constant Value: 0

Public Constructors

public Metadata ()

Public Methods

public String getAlternateLink ()

Returns a link for opening the file using a relevant Google editor or viewer.

public int getContentAvailability ()

Returns CONTENT_NOT_AVAILABLE_LOCALLY when the content is not available on the device or CONTENT_AVAILABLE_LOCALLY when the content is available on the device.

public Date getCreatedDate ()

Returns the create time for this resource.

public Map<CustomPropertyKey, String> getCustomProperties ()

Gets all custom properties and their associated values.

public String getDescription ()

A short description of the resource.

public DriveId getDriveId ()

Returns the id of the resource

public String getEmbedLink ()

A link for embedding the file.

public String getFileExtension ()

The file extension used when downloading this file.

public long getFileSize ()

The size of the file in bytes. Will return 0 for a folder.

This is only populated for files with content stored in Drive.

public Date getLastViewedByMeDate ()

Returns the last time this resource was viewed by the user or null if the user never viewed this resource.

public String getMimeType ()

Returns the MIME type of the resource

public Date getModifiedByMeDate ()

Returns the last time this resource was modified by the user or null if the user never modified this resource.

public Date getModifiedDate ()

Returns the last time this resource was modified by anyone.

public String getOriginalFilename ()

The original filename if the file was uploaded manually, or the original title if the file was inserted through the API.

public long getQuotaBytesUsed ()

The number of quota bytes used by this file. Will return 0 for a folder.

public Date getSharedWithMeDate ()

Returns the time at which this resource was shared with the user or null if the user is the owner of this resource.

public String getTitle ()

Returns the title of the resource

public String getWebContentLink ()

A link for downloading the content of the file in a browser using cookie based authentication.

public String getWebViewLink ()

A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

public boolean isEditable ()

Returns true if this resource can be edited by the current user.

public boolean isExplicitlyTrashed ()

Returns true if this resource has been explicitly trashed, as opposed to recursively trashed. This will return false if the file is not trashed.

public boolean isFolder ()

Returns true if this Metadata is for a folder.

public boolean isInAppFolder ()

Returns true if this resource is in the Application Folder.

The App Folder contains hidden files stored in a user's Drive that are only accessible to the creating app. @see https://developers.google.com/drive/appdata

public boolean isPinnable ()

Returns true if the resource can be pinned. Folders and some shortcut app MIME types are pinnable.

public boolean isPinned ()

Returns true if this resource has been pinned (a request has been made to make the content available offline).

public boolean isRestricted ()

Whether viewers are prevented from downloading this file.

public boolean isShared ()

Returns true if this resource is a shared resource.

public boolean isStarred ()

Returns true if this resource is starred by the user.

public boolean isTrashable ()

Returns true if this resource can be trashed by this user.

public boolean isTrashed ()

Returns true if this resource has been trashed.

public boolean isViewed ()

Whether this file has been viewed by this user.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated June 27, 2016.