Package com.amilesend.onedrive.resource.drive

Class Drive

java.lang.Object

com.amilesend.onedrive.resource.item.BaseItem

com.amilesend.onedrive.resource.drive.Drive

public class Drive
extends BaseItem

Top-level object that represents a user's OneDrive or SharePoint document library.

API Documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Drive.DriveBuilder<C extends Drive,B extends Drive.DriveBuilder<C,B>>

Nested classes/interfaces inherited from class com.amilesend.onedrive.resource.item.BaseItem

BaseItem.BaseItemBuilder<C extends BaseItem,B extends BaseItem.BaseItemBuilder<C,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DRIVE_BASE_URL_PATH
static final String	DRIVE_URL_PATH_SUFFIX
static final String	DRIVES_BASE_URL_PATH
static final String	DRIVES_URL_PATH_SUFFIX

Method Summary

Modifier and Type	Method	Description
static Drive.DriveBuilder<?,?>	builder()
boolean	equals(Object obj)
List<ItemActivity>	getActivities()	Queries and fetches the activities associated with this Drive.
List<DriveItem>	getChanges()	Fetches the list of changes associated with this Drive.
OneDriveConnection	getConnection()
String	getDriveType()	The drive type descriptor.
IdentitySet	getOwner()	The user account that owns the drive.
Quota	getQuota()	Drive storage space quota information.
DriveItem	getRootFolder()	Fetches the root folder associated with this Drive.
SharePointIds	getSharepointIds()	Identifiers used for SharePoint.
SpecialDriveItem	getSpecialFolder(SpecialFolder.Type type)	Retrieves a special folder for the given SpecialFolder.Type.
Object	getSystem()	Indicates that this is a system-managed drive: Note: Either null or defined as empty.
int	hashCode()
List<DriveItem>	search(String query)	Search for items associated with this Drive.
String	toString()

Methods inherited from class com.amilesend.onedrive.resource.item.BaseItem

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

DRIVE_BASE_URL_PATH

public static final String DRIVE_BASE_URL_PATH

See Also:

• Constant Field Values

DRIVES_BASE_URL_PATH

public static final String DRIVES_BASE_URL_PATH

See Also:

• Constant Field Values

DRIVE_URL_PATH_SUFFIX

public static final String DRIVE_URL_PATH_SUFFIX

See Also:

• Constant Field Values

DRIVES_URL_PATH_SUFFIX

public static final String DRIVES_URL_PATH_SUFFIX

See Also:

• Constant Field Values

Method Details

getActivities

public List<ItemActivity> getActivities()

Queries and fetches the activities associated with this Drive.

API Documentation.

Returns:

the list of activities

getRootFolder

public DriveItem getRootFolder()

Fetches the root folder associated with this Drive.

API Documentation.

Returns:

the root folder drive item

getChanges

public List<DriveItem> getChanges()

Fetches the list of changes associated with this Drive.

API Documentation.

Returns:

the list of drive item changes

search

public List<DriveItem> search(String query)

Search for items associated with this Drive.

API Documentation.

Parameters:

query - the search query

Returns:

the list of drive items associated with the query

getSpecialFolder

public SpecialDriveItem getSpecialFolder(SpecialFolder.Type type)

Retrieves a special folder for the given SpecialFolder.Type.

Parameters:

type - the special folder type

Returns:

the special folder drive item

See Also:

• SpecialFolder.Type

equals

public boolean equals(Object obj)

Overrides:

equals in class BaseItem

hashCode

public int hashCode()

Overrides:

hashCode in class BaseItem

builder

public static Drive.DriveBuilder<?,?> builder()

getDriveType

public String getDriveType()

The drive type descriptor. Valid types are:

• personal - Personal drive
• business - Business drive
• documentLibrary - Sharepoint document library

getOwner

public IdentitySet getOwner()

The user account that owns the drive.

getQuota

public Quota getQuota()

Drive storage space quota information.

getSharepointIds

public SharePointIds getSharepointIds()

Identifiers used for SharePoint.

getSystem

public Object getSystem()

Indicates that this is a system-managed drive: Note: Either null or defined as empty.

getConnection

public OneDriveConnection getConnection()

toString

public String toString()

Overrides:

toString in class BaseItem