DriveFile

  • DriveFile is an interface providing access to the contents and metadata of a file in Drive, retrievable using its drive id.

  • The nested interface DriveFile.OpenMode defines the available modes for opening a file.

  • The constants MODE_READ_ONLY, MODE_READ_WRITE, and MODE_WRITE_ONLY specify different access levels when opening a file's contents.

  • The deprecated open method allows opening DriveContents associated with the file, returning a temporary copy for read and/or write access, with newer recommended methods available.

  • DriveFile inherits various methods from the DriveResource interface for managing file resources, many of which are also deprecated with newer alternatives suggested.
public interface DriveFile implements DriveResource

A file in Drive. This class provides access to the contents and metadata of the specified file. To retrieve a DriveFile from a known drive id, use asDriveFile().

Nested Class Summary

interface DriveFile.DownloadProgressListener This interface was deprecated. Use OpenFileCallback instead.  
@interface DriveFile.OpenMode The available modes that a file can be opened in. 

Constant Summary

int MODE_READ_ONLY A mode that opens the contents only for reading.
int MODE_READ_WRITE A mode that opens the contents for reading and writing.
int MODE_WRITE_ONLY A mode that opens the contents only for writing.

Public Method Summary

abstract PendingResult<DriveApi.DriveContentsResult>
open(GoogleApiClient apiClient, int mode, DriveFile.DownloadProgressListener listener)
This method was deprecated. Use openFile(DriveFile, int) or openFile(DriveFile, int, OpenFileCallback) instead.

Inherited Method Summary

Constants

public static final int MODE_READ_ONLY

A mode that opens the contents only for reading.

Constant Value: 268435456

public static final int MODE_READ_WRITE

A mode that opens the contents for reading and writing.

Constant Value: 805306368

public static final int MODE_WRITE_ONLY

A mode that opens the contents only for writing.

Constant Value: 536870912

Public Methods

public abstract PendingResult<DriveApi.DriveContentsResult> open (GoogleApiClient apiClient, int mode, DriveFile.DownloadProgressListener listener)

This method was deprecated.
Use openFile(DriveFile, int) or openFile(DriveFile, int, OpenFileCallback) instead.

Opens the DriveContents that are associated with this file for read and/or write. The returned file is a temporary copy available only to this app. The contents must be closed via commit(GoogleApiClient, MetadataChangeSet) or discard(GoogleApiClient).

Availability

The contents are returned when they are available on the device in their entirety. Content is returned from the cache if it is available and up to date, otherwise it will be downloaded from the server. To listen for download progress, provide a DriveFile.DownloadProgressListener. Note: If the download fails, e.g. due to the device going offline, the cached version will be returned (if available).

Note: to open the file in edit mode, the user must have edit access. See isEditable().

Parameters
apiClient The GoogleApiClient to service the call.
mode Describes the mode in which to open the file. Possible values are MODE_READ_ONLY, MODE_READ_WRITE and MODE_WRITE_ONLY.
listener An optional listener that will announce progress as the file is downloaded. If you don't care about progress, provide null.
Returns
  • A PendingResult which can be used to retrieve the DriveContents when they are available. If isSuccess() returns true, it is recommended to check getStatusCode(), since two possible values are considered success: SUCCESS which means that the returned DriveContents is up to date, or SUCCESS_CACHE which means that the returned DriveContents is a cached version, since the most up to date version could not be downloaded to the device (for example, due to connectivity).