Class DriveFile

java.lang.Object

com.amilesend.onedrive.resource.DriveItemType

com.amilesend.onedrive.resource.DriveFile

public class DriveFile
extends DriveItemType

A wrapper around a DriveItem that represents a file.

Constructor Summary

Constructors

Constructor	Description
DriveFile(DriveItem delegate)	Creates a new DriveFile that wraps the given getDelegate() DriveItem.

Method Summary

Modifier and Type	Method	Description
void	download(Path folderPath)	Downloads this file to the given folderPath.
void	download(Path folderPath, com.amilesend.client.connection.file.TransferProgressCallback callback)	Downloads this file to the given folderPath and reports transfer progress to the specified TransferProgressCallback.
DriveFileDownloadExecution	downloadAsync(Path folderPath)	Downloads this file asynchronously to the given folderPath.
DriveFileDownloadExecution	downloadAsync(Path folderPath, com.amilesend.client.connection.file.TransferProgressCallback callback)	Downloads this file asynchronously to the given folderPath and reports transfer progress to the specified TransferProgressCallback.
Audio	getAudioAttributes()	Gets the audio file attributes.
Image	getImageAttributes()	Gets the image file attributes.
GeoCoordinates	getLocationAttributes()	Gets the location attributes (e.g., photo taken from a cell phone).
Photo	getPhotoAttributes()	Gets the photo attributes (e.g., photo taken from a cell phone).
Video	getVideoAttributes()	Gets the vidoe file attributes.
boolean	isAudio()	Describes if this is an audio file.
boolean	isImage()	Describes if this is an image file.
boolean	isLocationAvailable()	Determines if there is geolocation attributes for this file.
boolean	isPhoto()	Describes if this has photo attributes.
boolean	isVideo()	Describes if this is a video file.
DriveFile	move(@NonNull DriveFolder destinationFolder, String newName)	Moves this file to the specified DriveFolder along with the new file name.
DriveFile	move(DriveFolder destinationFolder)	Moves this file to the specified DriveFolder.
DriveFile	move(String destinationParentId, String newName)	Moves this file to the specified newParentId (i.e., represents a new DriveFolder's ID) along with the new file name.
Preview	preview(PreviewRequest request)	Gets the embeddable file preview URLs for inclusion in a web-based UI.
String	toString()
DriveFile	update()	Updates the attributes for this file.
DriveFile	upload(File file)	Deprecated. use upload(Path) instead
DriveFile	upload(File file, com.amilesend.client.connection.file.TransferProgressCallback callback)	Deprecated. use upload(Path, TransferProgressCallback) instead
DriveFile	upload(Path filePath)	Uploads and replaces this drive file's contents with the given file.
DriveFile	upload(Path filePath, com.amilesend.client.connection.file.TransferProgressCallback callback)	Uploads and replaces this drive file's contents with the given file and reports transfer progress to the specified TransferProgressCallback.
DriveFileUploadExecution	uploadAsync(File file)	Deprecated. use uploadAsync(Path) instead
DriveFileUploadExecution	uploadAsync(File file, com.amilesend.client.connection.file.TransferProgressCallback callback)	Deprecated. use uploadAsync(Path, TransferProgressCallback) instead
DriveFileUploadExecution	uploadAsync(Path filePath)	Uploads and replaces this drive file's contents asynchronously with the given file.
DriveFileUploadExecution	uploadAsync(Path filePath, com.amilesend.client.connection.file.TransferProgressCallback callback)	Uploads and replaces this drive file's contents asynchronously with the given file and reports transfer progress to the specified TransferProgressCallback.

Methods inherited from class DriveItemType

addPermission, copy, copy, copy, copy, createSharingLink, delete, equals, getActivities, getCreatedBy, getCreatedDateTime, getETag, getFileSystemInfo, getId, getLastModifiedBy, getLastModifiedDateTime, getName, getPackage, getParentReference, getPermissions, getRemoteItem, getThumbnails, getVersions, hashCode, isDeleted, isFile, isFolder, isPackage, isRemote, setFileSystemInfo

Modifier and Type	Method	Description
List<Permission>	addPermission(AddPermissionRequest request)	Adds a permission for the given request.
AsyncJob	copy(@NonNull DriveFolder destinationFolder, String newName)	Copies this drive item type to the specified DriveFolder along with the new file name.
AsyncJob	copy(DriveFolder destinationFolder)	Copies this drive item type to the specified DriveFolder.
AsyncJob	copy(String newName)	Copies this drive item type to the specified newName within the same folder.
AsyncJob	copy(String destinationParentId, String newName)	Copies this drive item type to the specified newParentId (i.e., represents a new DriveFolder's ID) along with the new file name.
Permission	createSharingLink(CreateSharingLinkRequest request)	Creates a sharing link for the given request.
void	delete()	Mark this drive item type for deletion.
boolean	equals(Object obj)
List<ItemActivity>	getActivities()	Gets the list of activities associated with this drive item.
IdentitySet	getCreatedBy()	Gets the identity set that indicates who created this drive item.
String	getCreatedDateTime()	Gets the timestamp (formatted as a string) that indicates when this drive item was created.
String	getETag()	Gets the eTag associated with this item.
FileSystemInfo	getFileSystemInfo()	Gets the local file system information associated with this drive item.
String	getId()	Gets the drive item identifier.
IdentitySet	getLastModifiedBy()	Gets the identity set that indicates who made the last modification to this drive item.
String	getLastModifiedDateTime()	Gets the timestamp (formatted as a string) that indicates when this drive item was modified.
String	getName()	Gets the name of this drive item.
Package	getPackage()	Gets the package information associated with this drive item.
ItemReference	getParentReference()	Gets the parent reference of this drive item.
List<Permission>	getPermissions()	Gets the list of permissions associated with this drive item.
RemoteItem	getRemoteItem()	Gets the remote item information.
List<ThumbnailSet>	getThumbnails()	Gets the list thumbnails associated with this drive item.
List<DriveItemVersion>	getVersions()	Gets the list of versions for this drive item.
int	hashCode()
boolean	isDeleted()	Describes if this drive item has been marked for deletion.
boolean	isFile()	Describes if this is a file.
boolean	isFolder()	Describes if this is a folder.
boolean	isPackage()	Describes if this is a package.
boolean	isRemote()	Describes if this drive item represents a remote item from another drive.
void	setFileSystemInfo(@NonNull FileSystemInfo fileSystemInfo)	Sets the local file system information associated with this drive item.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DriveFile

public DriveFile(DriveItem delegate)

Creates a new DriveFile that wraps the given getDelegate() DriveItem.

Parameters:

delegate - the drive item to wrap

Method Details

isAudio

public boolean isAudio()

Describes if this is an audio file.

Returns:

true if this file is an audio file; else, false

getAudioAttributes

public Audio getAudioAttributes()

Gets the audio file attributes. Can be null.

Returns:

the audio file attributes

See Also:

• Audio

isImage

public boolean isImage()

Describes if this is an image file.

Returns:

true if this file is an image file; else, false

getImageAttributes

public Image getImageAttributes()

Gets the image file attributes. Can be null.

Returns:

the image file attributes

See Also:

• Image

isLocationAvailable

public boolean isLocationAvailable()

Determines if there is geolocation attributes for this file.

Returns:

true if this file has location attributes; else, false

getLocationAttributes

public GeoCoordinates getLocationAttributes()

Gets the location attributes (e.g., photo taken from a cell phone). Can be null.

Returns:

the location file attributes

See Also:

• GeoCoordinates

isPhoto

public boolean isPhoto()

Describes if this has photo attributes. Can be null.

Returns:

true if this file contains photo attributes; else, false

getPhotoAttributes

public Photo getPhotoAttributes()

Gets the photo attributes (e.g., photo taken from a cell phone). Can be null.

Returns:

the photo attributes

See Also:

• Photo

isVideo

public boolean isVideo()

Describes if this is a video file.

Returns:

true if this file is a video file; else, false

getVideoAttributes

public Video getVideoAttributes()

Gets the vidoe file attributes. Can be null.

Returns:

the video file attributes

See Also:

• Video

toString

public String toString()

Overrides:

toString in class Object

download

public void download(Path folderPath)

Downloads this file to the given folderPath.

Parameters:

folderPath - the folder to download the file to

download

public void download(Path folderPath,
 com.amilesend.client.connection.file.TransferProgressCallback callback)

Downloads this file to the given folderPath and reports transfer progress to the specified TransferProgressCallback.

Parameters:

folderPath - the folder to download the file to

callback - the callback be notified of transfer progress

See Also:

• TransferProgressCallback

downloadAsync

public DriveFileDownloadExecution downloadAsync(Path folderPath)

Downloads this file asynchronously to the given folderPath. Consumers can block on transfer completion by invoking DriveFileDownloadExecution.get() ()}.

Parameters:

folderPath - the folder to download the file to

Returns:

the asynchronous execution that contains the number of bytes downloaded

See Also:

• DriveFileDownloadExecution

downloadAsync

public DriveFileDownloadExecution downloadAsync(Path folderPath,
 com.amilesend.client.connection.file.TransferProgressCallback callback)

Downloads this file asynchronously to the given folderPath and reports transfer progress to the specified TransferProgressCallback. Consumers can block on transfer completion by invoking DriveFileDownloadExecution.get().

Parameters:

folderPath - the folder to download the file to

callback - the callback be notified of transfer progress

Returns:

the asynchronous execution that contains the number of bytes downloaded

See Also:

• TransferProgressCallback
• DriveFileDownloadExecution

upload

@Deprecated
public DriveFile upload(File file)
                 throws IOException

Deprecated.

use upload(Path) instead

Uploads and replaces this drive file's contents with the given file.

Parameters:

file - the updated file contents

Returns:

a new drive file that represents this updated file

Throws:

IOException - if unable to read the file.

See Also:

• DriveFile

upload

public DriveFile upload(Path filePath)
                 throws IOException

Uploads and replaces this drive file's contents with the given file.

Parameters:

filePath - the updated file contents

Returns:

a new drive file that represents this updated file

Throws:

IOException - if unable to read the file.

See Also:

• DriveFile

upload

@Deprecated
public DriveFile upload(File file,
 com.amilesend.client.connection.file.TransferProgressCallback callback)
                 throws IOException

Deprecated.

use upload(Path, TransferProgressCallback) instead

Uploads and replaces this drive file's contents with the given file and reports transfer progress to the specified TransferProgressCallback.

Parameters:

file - the updated file contents

callback - the callback be notified of transfer progress

Returns:

a new drive file that represents this updated file

Throws:

IOException - if unable to read the file.

See Also:

• DriveFile

upload

public DriveFile upload(Path filePath,
 com.amilesend.client.connection.file.TransferProgressCallback callback)
                 throws IOException

Uploads and replaces this drive file's contents with the given file and reports transfer progress to the specified TransferProgressCallback.

Parameters:

filePath - the updated file contents

callback - the callback be notified of transfer progress

Returns:

a new drive file that represents this updated file

Throws:

IOException - if unable to read the file.

See Also:

• DriveFile

uploadAsync

@Deprecated
public DriveFileUploadExecution uploadAsync(File file)
                                     throws IOException

Deprecated.

use uploadAsync(Path) instead

Uploads and replaces this drive file's contents asynchronously with the given file. Consumers can block on transfer completion by invoking DriveFileUploadExecution.get().

Parameters:

file - the updated file contents

Returns:

a new drive file that represents this updated file

Throws:

IOException - if unable to read the file.

See Also:

• DriveFileUploadExecution

uploadAsync

public DriveFileUploadExecution uploadAsync(Path filePath)
                                     throws IOException

Uploads and replaces this drive file's contents asynchronously with the given file. Consumers can block on transfer completion by invoking DriveFileUploadExecution.get().

Parameters:

filePath - the updated file contents

Returns:

a new drive file that represents this updated file

Throws:

IOException - if unable to read the file.

See Also:

• DriveFileUploadExecution

uploadAsync

@Deprecated
public DriveFileUploadExecution uploadAsync(File file,
 com.amilesend.client.connection.file.TransferProgressCallback callback)
                                     throws IOException

Deprecated.

use uploadAsync(Path, TransferProgressCallback) instead

Uploads and replaces this drive file's contents asynchronously with the given file and reports transfer progress to the specified TransferProgressCallback.

Parameters:

file - the updated file contents

callback - the callback be notified of transfer progress

Returns:

the async execution used to obtain the drive file once it has completed

Throws:

IOException - if unable to read the file.

See Also:

• TransferProgressCallback

uploadAsync

public DriveFileUploadExecution uploadAsync(Path filePath,
 com.amilesend.client.connection.file.TransferProgressCallback callback)
                                     throws IOException

Uploads and replaces this drive file's contents asynchronously with the given file and reports transfer progress to the specified TransferProgressCallback.

Parameters:

filePath - the updated file contents

callback - the callback be notified of transfer progress

Returns:

the async execution used to obtain the drive file once it has completed

Throws:

IOException - if unable to read the file.

See Also:

• TransferProgressCallback

update

public DriveFile update()

Updates the attributes for this file.

Returns:

the updated drive file

preview

public Preview preview(PreviewRequest request)

Gets the embeddable file preview URLs for inclusion in a web-based UI. Note: For long-lived embeddable links, use DriveItemType.createSharingLink(CreateSharingLinkRequest) instead.

Parameters:

request - the preview item request

Returns:

the preview URLs

move

public DriveFile move(DriveFolder destinationFolder)

Moves this file to the specified DriveFolder.

Parameters:

destinationFolder - the destination drive folder

Returns:

the updated drive file that represents this moved file

move

public DriveFile move(@NonNull DriveFolder destinationFolder,
 String newName)

Moves this file to the specified DriveFolder along with the new file name.

Parameters:

destinationFolder - the destination drive folder

newName - the new name of the file

Returns:

the updated drive file that represents this moved file

move

public DriveFile move(String destinationParentId,
 String newName)

Moves this file to the specified newParentId (i.e., represents a new DriveFolder's ID) along with the new file name.

Parameters:

destinationParentId - the new parent destination ID

newName - the new name of the file

Returns:

the updated drive file that represents this moved file.