Class ListItem

java.lang.Object

com.amilesend.onedrive.resource.item.BaseItem

com.amilesend.onedrive.resource.site.ListItem

public class ListItem
extends BaseItem

Represents an item in a list.

API Documentation.

See Also:

• List

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListItem.ListItemBuilder<C extends ListItem, B extends ListItem.ListItemBuilder<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_ITEM_BASE_URL_PATH
static final String	LIST_ITEM_URL_SUFFIX

Method Summary

Modifier and Type	Method	Description
static ListItem.ListItemBuilder<?,?>	builder()
void	delete()	Deletes this item from the list.
boolean	equals(Object o)
GetColumnValuesResponse	getColumnValues()	Gets the associated columns and its values.
GetColumnValuesResponse	getColumnValues(List<String> columnsToSelect)	Gets the selected columns and its values for the given list of column names.
OneDriveConnection	getConnection()	The OneDrive API connection.
ContentType	getContentType()	The content type of this list item.
DriveItem	getDriveItem()	For document libraries, the list item as a drive item.
Map<String,Object>	getFields()	The key is the name of the column, the value is the associated value of the columns set on this list item.
String	getListId()	The associated list identifier.
List<ListItemVersion>	getListItemVersions()	Gets the list of versions for this list item.
SharePointIds	getSharepointIds()	The Sharepoint identifiers.
String	getSiteId()	The associated site identifier.
ListItemVersion	getVersion(String versionId)	Gets the ListItemVersion for the given versionId.
int	hashCode()
boolean	isDeleted()	Indicates if this item is deleted or not (read-only).
void	setContentType(ContentType contentType)	The content type of this list item.
String	toString()
ListItem	update()	Updates this list item (e.g., name, description, parentReference, content type).
Map<String,Object>	updateColumnValues(Map<String,Object> fields)	Updates the defined columns and associated values for this list item.

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_ITEM_BASE_URL_PATH

public static final String LIST_ITEM_BASE_URL_PATH

See Also:

• Constant Field Values

LIST_ITEM_URL_SUFFIX

public static final String LIST_ITEM_URL_SUFFIX

See Also:

• Constant Field Values

Method Details

getColumnValues

public GetColumnValuesResponse getColumnValues()

Gets the associated columns and its values.

API Documentation.

Returns:

the response

See Also:

• GetColumnValuesResponse

getColumnValues

public GetColumnValuesResponse getColumnValues(List<String> columnsToSelect)

Gets the selected columns and its values for the given list of column names.

API Documentation.

Parameters:

columnsToSelect - the list of column names (max 12)

Returns:

the response

See Also:

• GetColumnValuesResponse

updateColumnValues

public Map<String,Object> updateColumnValues(Map<String,Object> fields)

Updates the defined columns and associated values for this list item. All other values on the list item are left alone.

API Documentation.

Parameters:

fields - the fields to update

Returns:

the field value set containing all the columns and values

getListItemVersions

public List<ListItemVersion> getListItemVersions()

Gets the list of versions for this list item.

API Documentation.

Returns:

the list item versions

getVersion

public ListItemVersion getVersion(String versionId)

Gets the ListItemVersion for the given versionId.

API Documentation.

Parameters:

versionId - the list item version identifier

Returns:

the list item version

update

public ListItem update()

Updates this list item (e.g., name, description, parentReference, content type).

API Documentation.

Returns:

the updated list item

delete

public void delete()

Deletes this item from the list.

API Documentation.

builder

public static ListItem.ListItemBuilder<?,?> builder()

equals

public boolean equals(Object o)

Overrides:

equals in class BaseItem

hashCode

public int hashCode()

Overrides:

hashCode in class BaseItem

getFields

public Map<String,Object> getFields()

The key is the name of the column, the value is the associated value of the columns set on this list item.

getSharepointIds

public SharePointIds getSharepointIds()

The Sharepoint identifiers.

getDriveItem

public DriveItem getDriveItem()

For document libraries, the list item as a drive item.

getSiteId

public String getSiteId()

The associated site identifier.

getListId

public String getListId()

The associated list identifier.

getConnection

public OneDriveConnection getConnection()

The OneDrive API connection.

getContentType

public ContentType getContentType()

The content type of this list item.

isDeleted

public boolean isDeleted()

Indicates if this item is deleted or not (read-only).

toString

public String toString()

Overrides:

toString in class BaseItem

setContentType

public void setContentType(ContentType contentType)

The content type of this list item.