Class SpecialDriveItem

java.lang.Object

com.amilesend.onedrive.resource.item.BaseItem

com.amilesend.onedrive.resource.item.DriveItem

com.amilesend.onedrive.resource.item.SpecialDriveItem

public class SpecialDriveItem
extends DriveItem

Represent a special drive folder.

a href="https://learn.microsoft.com/en-us/onedrive/developer/rest-api/api/drive_get_specialfolder"> API Documentation.

Note: Documentation mentions to reference special folder by name, but seems to be by id instead (e.g., "approot" instead of "App+Root" in the path).

See Also:

• DriveItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpecialDriveItem.SpecialDriveItemBuilder<C extends SpecialDriveItem, B extends SpecialDriveItem.SpecialDriveItemBuilder<C,B>>

Nested classes/interfaces inherited from class DriveItem

DriveItem.DriveItemBuilder<C,B>

Modifier and Type	Class	Description
static class	DriveItem.DriveItemBuilder<C extends DriveItem, B extends DriveItem.DriveItemBuilder<C,B>>

Nested classes/interfaces inherited from class BaseItem

BaseItem.BaseItemBuilder<C,B>

Modifier and Type	Class	Description
static class	BaseItem.BaseItemBuilder<C extends BaseItem, B extends BaseItem.BaseItemBuilder<C,B>>

Field Summary

Fields inherited from class DriveItem

DRIVE_ITEM_BASE_URL_PATH

Modifier and Type	Field	Description
static final String	DRIVE_ITEM_BASE_URL_PATH

Method Summary

Modifier and Type	Method	Description
static SpecialDriveItem.SpecialDriveItemBuilder<?,?>	builder()
boolean	equals(Object obj)
List<DriveItem>	getChildren()	Fetches the list of child DriveItems associated with this DriveItem.
SpecialFolder.Type	getSpecialFolderType()	The special folder type.
int	hashCode()
void	setSpecialFolderType(SpecialFolder.Type specialFolderType)	The special folder type.
String	toString()

Methods inherited from class DriveItem

addPermission, copy, create, createSharingLink, delete, download, downloadAsync, get_package, getActivities, getAudio, getConflictBehavior, getConnection, getCTag, getDeleted, getDownloadUrl, getFile, getFileSystemInfo, getFolder, getImage, getLocation, getMalware, getPermissions, getPhoto, getPublication, getRemoteItem, getRoot, getSearchResult, getShared, getSharepointIds, getSize, getSourceUrl, getSpecialFolder, getThumbnails, getVersions, getVideo, move, previewItem, search, setConflictBehavior, setFileSystemInfo, setSourceUrl, update, upload, uploadAsync, uploadNew, uploadNewAsync

Modifier and Type	Method	Description
List<Permission>	addPermission(@NonNull AddPermissionRequest requestBody)	Adds a permission to this DriveItem for the given request.
AsyncJob	copy(String destinationParentId, String newName)	Copies this DriveItem to a child of the given destinationParentId and updates the name of the copied DriveItem.
DriveItem	create(@NonNull DriveItem newChildDriveItem)	Creates a new DriveItem as a child of this.
Permission	createSharingLink(@NonNull CreateSharingLinkRequest requestBody)	Creates a sharing link for the given request.
void	delete()	Deletes this drive item.
void	download(@NonNull Path folderPath, @NonNull com.amilesend.client.connection.file.TransferProgressCallback callback)	Downloads the drive item and reports transfer progress to the given TransferProgressCallback.
CompletableFuture<Long>	downloadAsync(@NonNull Path folderPath, @NonNull com.amilesend.client.connection.file.TransferProgressCallback callback)	Downloads the drive item asynchronously that reports transfer progress and completion to the specified TransferProgressCallback.
Package	get_package()	Indicates that a drive item is the top level item in a collection of items (read-only).
List<ItemActivity>	getActivities()	Queries and fetches the activities associated with this DriveItem.
Audio	getAudio()	The audio file attributes (read-only).
String	getConflictBehavior()	Describes how to handle conflicts upon copy/move operations.
OneDriveConnection	getConnection()	Gets the underlying connection instance.
String	getCTag()	An eTag for the content of the item (read-only).
Deleted	getDeleted()	Indicates if an item was deleted (read-only).
String	getDownloadUrl()	The URL that can be used to download the file's content (read-only).
File	getFile()	Indicates if an item is a file (read-only).
FileSystemInfo	getFileSystemInfo()	Describes drive (client-side) properties of the local version of a drive item.
Folder	getFolder()	Describes if a given drive item is a folder resource type (read-only).
Image	getImage()	The image attributes for a file (read-only).
GeoCoordinates	getLocation()	The geographic coordinates and elevation of a file (read-only).
Object	getMalware()	If defined, malware was detected in the file (read-only).
List<Permission>	getPermissions()	Fetches the list of permissions associated with this DriveItem.
Photo	getPhoto()	The photo attributes for a drive item file (read-only).
PublicationFacet	getPublication()	The published status of a drive item or version (read-only).
RemoteItem	getRemoteItem()	Indicates that a drive item references one that exists in another drive (read-only).
Object	getRoot()	If defined, indicates that the item is the top-most folder in the drive (read-only).
SearchResult	getSearchResult()	Indicates that the item is in response to a search query (read-only).
Shared	getShared()	Indicates that a drive item has been shared with others (read-only).
SharePointIds	getSharepointIds()	SharePoint resource identifiers for SharePoint and Business account items (read-only).
long	getSize()	The size of the item in bytes (read-only).
String	getSourceUrl()	The source URL for remote uploading of file contents (write-only).
SpecialFolder	getSpecialFolder()	Describes if the item is a special managed folder (read-only).
List<ThumbnailSet>	getThumbnails()	Fetches the list of thumbnail sets associated with this DriveItem.
List<DriveItemVersion>	getVersions()	Fetches the list of versions of this DriveItem.
Video	getVideo()	The video file attributes (read-only).
DriveItem	move(String destinationParentId, String newName)	Moves this DriveItem as a child to the given newParentId, updates the name, or both.
Preview	previewItem(@NonNull PreviewRequest requestBody)	Gets the embeddable file preview URLs for inclusion in a web-based UI.
List<DriveItem>	search(String query)	Search for items associated with this DriveItem.
void	setConflictBehavior(String conflictBehavior)	Describes how to handle conflicts upon copy/move operations.
void	setFileSystemInfo(FileSystemInfo fileSystemInfo)	Describes drive (client-side) properties of the local version of a drive item.
void	setSourceUrl(String sourceUrl)	The source URL for remote uploading of file contents (write-only).
DriveItem	update()	Updates this drive item.
DriveItem	upload(@NonNull Path filePath, @NonNull com.amilesend.client.connection.file.TransferProgressCallback callback)	Uploads a file to replace the contents of this DriveItem and reports the transfer status to the given TransferProgressCallback.
CompletableFuture<DriveItem>	uploadAsync(@NonNull Path filePath, @NonNull com.amilesend.client.connection.file.TransferProgressCallback callback)	Uploads a file asynchronously to replace the contents of this DriveItem and reports the transfer status to the given TransferProgressCallback.
DriveItem	uploadNew(@NonNull Path filePath, @NonNull com.amilesend.client.connection.file.TransferProgressCallback callback)	Uploads a new file as a child of this DriveItem and reports the transfer status to the given TransferProgressCallback.
CompletableFuture<DriveItem>	uploadNewAsync(@NonNull Path filePath, @NonNull com.amilesend.client.connection.file.TransferProgressCallback callback)	Uploads a new file asynchronously as a child of this DriveItem and reports the transfer status to the given TransferProgressCallback.

Methods inherited from class BaseItem

getCreatedBy, getCreatedDateTime, getDescription, getETag, getId, getLastModifiedBy, getLastModifiedDateTime, getName, getParentReference, getUpdatedAttributesMap, getWebUrl, setDescription, setName, setParentReference

Modifier and Type	Method	Description
IdentitySet	getCreatedBy()	The source identity that created the item.
String	getCreatedDateTime()	Describes when the item was created.
String	getDescription()	Description of the item.
String	getETag()	Associated ETag for the item.
String	getId()	The unique identifier for the item.
IdentitySet	getLastModifiedBy()	The identity that last modified the item.
String	getLastModifiedDateTime()	Describes when the item was last modified.
String	getName()	The name of the item.
ItemReference	getParentReference()	Describes the parent information.
Map<String,Boolean>	getUpdatedAttributesMap()
String	getWebUrl()	URL for the resource shown in a browser.
void	setDescription(String description)	Sets the description for updating the drive item.
void	setName(String name)	Sets the updated drive item name.
void	setParentReference(ItemReference parentReference)	Sets the updated parent ItemReference used for moving a file to another folder.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

getChildren

public List<DriveItem> getChildren()

Description copied from class: DriveItem

Fetches the list of child DriveItems associated with this DriveItem.

API Documentation.

Overrides:

getChildren in class DriveItem

Returns:

list of child drive items

equals

public boolean equals(Object obj)

Overrides:

equals in class DriveItem

hashCode

public int hashCode()

Overrides:

hashCode in class DriveItem

builder

public static SpecialDriveItem.SpecialDriveItemBuilder<?,?> builder()

toString

public String toString()

Overrides:

toString in class DriveItem

getSpecialFolderType

public SpecialFolder.Type getSpecialFolderType()

The special folder type.

setSpecialFolderType

public void setSpecialFolderType(SpecialFolder.Type specialFolderType)

The special folder type.