Class DriveItemFolderType

java.lang.Object

com.amilesend.onedrive.resource.DriveItemType

com.amilesend.onedrive.resource.DriveItemFolderType

Direct Known Subclasses:

DriveFolder, DrivePackage

public abstract class DriveItemFolderType
extends DriveItemType

Defines shared operations between drive folders and packages.

See Also:

• DriveFolder
• DrivePackage

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DriveFolder	createFolder(String name)	Creates a new folder with the given name under this folder.
List<DriveFile>	getChildFiles()	Gets the list of child drive files under this folder.
List<DriveFolder>	getChildFolders()	Gets the list of child drive folders under this folder.
List<DrivePackage>	getChildPackages()	Gets the list of child drive packages under this folder.
List<? extends DriveItemType>	getChildren()	Gets the list of drive items (both folders and files) under this folder.
DriveFolder	move(@NonNull DriveFolder destinationFolder, String newName)	Moves this folder to the specified DriveFolder along with the new file name.
DriveFolder	move(DriveFolder destinationFolder)	Moves this folder to the specified DriveFolder.
DriveFolder	move(String destinationParentId, String newName)	Moves this folder to the specified newParentId (i.e., represents a new DriveFolder's ID) along with the new folder name.
List<? extends DriveItemType>	search(String query)	Searches this folder for the given query (e.g., file name).
DriveFolder	update()	Updates the attributes for this folder.
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 the given file under this folder.
DriveFile	upload(Path filePath, com.amilesend.client.connection.file.TransferProgressCallback callback)	Uploads the given file under this folder 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 the given file asynchronously under this folder.
DriveFileUploadExecution	uploadAsync(Path filePath, com.amilesend.client.connection.file.TransferProgressCallback callback)	Uploads the given file asynchronously under this folder 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, toString, wait, wait, wait

Constructor Details

DriveItemFolderType

public DriveItemFolderType(DriveItem delegate)

Creates a new DriveItemFolderType that wraps the given delegate DriveItem.

Parameters:

delegate - the drive item to wrap

Method Details

upload

@Deprecated
public DriveFile upload(File file)
                 throws IOException

Deprecated.

use upload(Path) instead

Uploads the given file under this folder.

Parameters:

file - the file to upload

Returns:

the drive file that represents the uploaded file

Throws:

IOException - if an error occurred while uploading the file

See Also:

• DriveFile

upload

public DriveFile upload(Path filePath)
                 throws IOException

Uploads the given file under this folder.

Parameters:

filePath - the file to upload

Returns:

the drive file that represents the uploaded file

Throws:

IOException - if an error occurred while uploading 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 the given file under this folder and reports transfer progress to the specified TransferProgressCallback.

Parameters:

file - the file to upload

callback - the callback be notified of transfer progress

Returns:

the drive file that represents the uploaded file

Throws:

IOException - if an error occurred while uploading the file

See Also:

• DriveFile

upload

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

Uploads the given file under this folder and reports transfer progress to the specified TransferProgressCallback.

Parameters:

filePath - the file to upload

callback - the callback be notified of transfer progress

Returns:

the drive file that represents the uploaded file

Throws:

IOException - if an error occurred while uploading the file

See Also:

• DriveFile

uploadAsync

@Deprecated
public DriveFileUploadExecution uploadAsync(File file)
                                     throws IOException

Deprecated.

use uploadAsync(Path) instead

Uploads the given file asynchronously under this folder.

Parameters:

file - the file to upload

Returns:

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

Throws:

IOException - if an error occurred while uploading the file

See Also:

• DriveFileUploadExecution

uploadAsync

public DriveFileUploadExecution uploadAsync(Path filePath)
                                     throws IOException

Uploads the given file asynchronously under this folder.

Parameters:

filePath - the file to upload

Returns:

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

Throws:

IOException - if an error occurred while uploading 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 the given file asynchronously under this folder and reports transfer progress to the specified TransferProgressCallback.

Parameters:

file - the file to upload

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 an error occurred while uploading the file

See Also:

• DriveFileUploadExecution

uploadAsync

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

Uploads the given file asynchronously under this folder and reports transfer progress to the specified TransferProgressCallback.

Parameters:

filePath - the file to upload

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 an error occurred while uploading the file

See Also:

• DriveFileUploadExecution

createFolder

public DriveFolder createFolder(String name)

Creates a new folder with the given name under this folder.

Parameters:

name - the name of the new folder

Returns:

the new drive folder

getChildPackages

public List<DrivePackage> getChildPackages()

Gets the list of child drive packages under this folder.

Returns:

the list of drive packages

getChildFolders

public List<DriveFolder> getChildFolders()

Gets the list of child drive folders under this folder.

Returns:

the list of drive folders

getChildFiles

public List<DriveFile> getChildFiles()

Gets the list of child drive files under this folder.

Returns:

the list of drive files

getChildren

public List<? extends DriveItemType> getChildren()

Gets the list of drive items (both folders and files) under this folder.

Returns:

the list of drive items

See Also:

• DriveItemType
• DriveItem

search

public List<? extends DriveItemType> search(String query)

Searches this folder for the given query (e.g., file name).

Parameters:

query - the search query

Returns:

the list of drive item types (either a DriveFolder or DriveFile).

See Also:

• DriveItemType
• DriveFile

update

public DriveFolder update()

Updates the attributes for this folder.

Returns:

the updated drive folder

move

public DriveFolder move(DriveFolder destinationFolder)

Moves this folder to the specified DriveFolder.

Parameters:

destinationFolder - the destination drive folder

Returns:

the updated drive file that represents this moved file

move

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

Moves this folder 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 folder that represents this moved folder

move

public DriveFolder move(String destinationParentId,
 String newName)

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

Parameters:

destinationParentId - the new parent destination ID

newName - the new name of the file

Returns:

the updated drive folder that represents this moved folder