com.google.android.gms.drive.DriveFile |
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 Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
DriveFile.DownloadProgressListener | A listener for progress events on an active contents download. |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
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 Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Opens the
DriveContents that are associated with this file for read and/or write. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
A mode that opens the contents only for reading.
A mode that opens the contents for reading and writing.
A mode that opens the contents only for writing.
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)
.
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 |
GoogleApiClient :
The GoogleApiClient to service the call. |
mode |
int :
Describes the mode in which to open the file. Possible values are
MODE_READ_ONLY , MODE_READ_WRITE and MODE_WRITE_ONLY . |
listener |
DriveFile.DownloadProgressListener :
An optional listener that will announce progress as the file is downloaded.
If you don't care about progress, provide null . |
Returns | |
---|---|
PendingResult<DriveApi.DriveContentsResult> |
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).
|