Class List

java.lang.Object

com.amilesend.onedrive.resource.item.BaseItem

com.amilesend.onedrive.resource.site.List

public class List
extends BaseItem

Represents a list resource in a site that describes the top-level properties of a list.

API Documentation.

See Also:

• Site
• ListItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	List.ListBuilder<C extends List, B extends List.ListBuilder<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	LIST_BASE_URL_PATH
static final String	LIST_URL_PATH_SUFFIX

Method Summary

Modifier and Type	Method	Description
static List.ListBuilder<?,?>	builder()
ListItem	createListItem(Map<String,Object> fields)	Creates a new ListItem for the given CreateListItemRequest.
boolean	equals(Object obj)
List<ItemActivity>	getActivities()	Queries and fetches the activities associated with this List.
List<ColumnDefinition>	getColumns()	The column definitions that apply to this list.
OneDriveConnection	getConnection()	The OneDrive API connection.
List<ContentType>	getContentTypes()	The content types for this list.
String	getDisplayName()	The list title.
Drive	getDrive()	When defined, indicates that this list exists within a document library and can be treated as a drive.
ListInfo	getList()	Additional list information.
String	getSiteId()	The associated site identifier that this list is associated with.
Object	getSystem()	Indicates that this is a system-managed list.
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

LIST_BASE_URL_PATH

public static final String LIST_BASE_URL_PATH

See Also:

• Constant Field Values

LIST_URL_PATH_SUFFIX

public static final String LIST_URL_PATH_SUFFIX

See Also:

• Constant Field Values

Method Details

createListItem

public ListItem createListItem(Map<String,Object> fields)

Creates a new ListItem for the given CreateListItemRequest.

API Documentation.

Parameters:

fields - The map of fields, with the key being the column name and the Object being its value

Returns:

the created list item

getActivities

public List<ItemActivity> getActivities()

Queries and fetches the activities associated with this List.

API Documentation.

Returns:

the list of activities

equals

public boolean equals(Object obj)

Overrides:

equals in class BaseItem

hashCode

public int hashCode()

Overrides:

hashCode in class BaseItem

builder

public static List.ListBuilder<?,?> builder()

getSystem

public Object getSystem()

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

getColumns

public List<ColumnDefinition> getColumns()

The column definitions that apply to this list.

getContentTypes

public List<ContentType> getContentTypes()

The content types for this list.

getDrive

public Drive getDrive()

When defined, indicates that this list exists within a document library and can be treated as a drive.

getSiteId

public String getSiteId()

The associated site identifier that this list is associated with.

getConnection

public OneDriveConnection getConnection()

The OneDrive API connection.

getDisplayName

public String getDisplayName()

The list title.

getList

public ListInfo getList()

Additional list information.

toString

public String toString()

Overrides:

toString in class BaseItem