Class Site

java.lang.Object

com.amilesend.onedrive.resource.item.BaseItem

com.amilesend.onedrive.resource.site.Site

public class Site
extends BaseItem

Top-level object that represents a SharePoint document library.

API Documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Site.SiteBuilder<C extends Site, B extends Site.SiteBuilder<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

Modifier and Type	Field	Description
static final String	SITE_BASE_URL_PATH
static final String	SITE_URL_PATH_SUFFIX

Method Summary

Modifier and Type	Method	Description
static Site.SiteBuilder<?,?>	builder()
boolean	equals(Object obj)
List<ColumnDefinition>	getColumns()	The column definitions that are reusable across lists under this site.
OneDriveConnection	getConnection()
List<ContentType>	getContentTypes()	The content types for the site.
Drive	getDefaultDocumentLibrary()	Gets the default document library for this site.
String	getDisplayName()	The full title for the site.
List<Drive>	getDocumentLibraries()	Gets all available document libraries for this site.
List<BaseItem>	getItems()	The items contained within this site.
List<List>	getLists()	Gets all lists under the site.
Object	getRoot()	If defined, indicates that the item is the top-most folder in the drive (read-only).
SharePointIds	getSharepointIds()	SharePoint resource identifiers for SharePoint and Business account items (read-only).
SiteCollection	getSiteCollection()	Provides details about the site's collection.
int	hashCode()
String	toString()

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

Field Details

SITE_BASE_URL_PATH

public static final String SITE_BASE_URL_PATH

See Also:

• Constant Field Values

SITE_URL_PATH_SUFFIX

public static final String SITE_URL_PATH_SUFFIX

See Also:

• Constant Field Values

Method Details

getDefaultDocumentLibrary

public Drive getDefaultDocumentLibrary()

Gets the default document library for this site.

API Documentation.

Returns:

the drive representing the default document library

getDocumentLibraries

public List<Drive> getDocumentLibraries()

Gets all available document libraries for this site.

API Documentation.

Returns:

the list of drives representing the document libraries.

getLists

public List<List> getLists()

Gets all lists under the site.

API Documentation.

Returns:

the associated lists

equals

public boolean equals(Object obj)

Overrides:

equals in class BaseItem

hashCode

public int hashCode()

Overrides:

hashCode in class BaseItem

builder

public static Site.SiteBuilder<?,?> builder()

getDisplayName

public String getDisplayName()

The full title for the site.

getRoot

public Object getRoot()

If defined, indicates that the item is the top-most folder in the drive (read-only).

getSharepointIds

public SharePointIds getSharepointIds()

SharePoint resource identifiers for SharePoint and Business account items (read-only).

getSiteCollection

public SiteCollection getSiteCollection()

Provides details about the site's collection. Only applies to root sites.

getContentTypes

public List<ContentType> getContentTypes()

The content types for the site.

getColumns

public List<ColumnDefinition> getColumns()

The column definitions that are reusable across lists under this site.

getItems

public List<BaseItem> getItems()

The items contained within this site. Note: Cannot be enumerated.

getConnection

public OneDriveConnection getConnection()

toString

public String toString()

Overrides:

toString in class BaseItem