Interface IListItemCollection

Public interface to define a collection of ListItem objects of SharePoint Online

Inherited Members
Namespace: PnP.Core.Model.SharePoint
Assembly: PnP.Core.dll
Syntax
public interface IListItemCollection : IDataModelCollection<IListItem>, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad<IListItem>, IDataModelCollectionDeleteByIntegerId, ISupportModules<IListItemCollection>

Methods

Add(Dictionary<String, Object>, String, FileSystemObjectType)

Adds a new list item

Declaration
IListItem Add(Dictionary<string, object> values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType))
Parameters
Dictionary<System.String, System.Object> values

Values to add to list item
System.String folderPath

Optional folder path to add the item to.
FileSystemObjectType underlyingObjectType

Type of object to create. Defaults to File/ListItem
Returns
IListItem

Newly added list item

AddAsync(Dictionary<String, Object>, String, FileSystemObjectType)

Adds a new list item

Declaration
Task<IListItem> AddAsync(Dictionary<string, object> values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType))
Parameters
Dictionary<System.String, System.Object> values

Values to add to list item
System.String folderPath

Optional folder path to add the item to.
FileSystemObjectType underlyingObjectType

Type of object to create. Defaults to File/ListItem
Returns
Task<IListItem>

Newly added list item

AddBatch(Dictionary<String, Object>, String, FileSystemObjectType)

Adds a new list item

Declaration
IListItem AddBatch(Dictionary<string, object> values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType))
Parameters
Dictionary<System.String, System.Object> values

Values to add to list item
System.String folderPath

Optional folder path to add the item to.
FileSystemObjectType underlyingObjectType

Type of object to create. Defaults to File/ListItem
Returns
IListItem

Newly added list item

AddBatch(Batch, Dictionary<String, Object>, String, FileSystemObjectType)

Adds a new list item

Declaration
IListItem AddBatch(Batch batch, Dictionary<string, object> values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType))
Parameters
Batch batch

Batch to use
Dictionary<System.String, System.Object> values

Values to add to list item
System.String folderPath

Optional folder path to add the item to.
FileSystemObjectType underlyingObjectType

Type of object to create. Defaults to File/ListItem
Returns
IListItem

Newly added list item

AddBatchAsync(Dictionary<String, Object>, String, FileSystemObjectType)

Adds a new list item

Declaration
Task<IListItem> AddBatchAsync(Dictionary<string, object> values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType))
Parameters
Dictionary<System.String, System.Object> values

Values to add to list item
System.String folderPath

Optional folder path to add the item to.
FileSystemObjectType underlyingObjectType

Type of object to create. Defaults to File/ListItem
Returns
Task<IListItem>

Newly added list item

AddBatchAsync(Batch, Dictionary<String, Object>, String, FileSystemObjectType)

Adds a new list item

Declaration
Task<IListItem> AddBatchAsync(Batch batch, Dictionary<string, object> values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType))
Parameters
Batch batch

Batch to use
Dictionary<System.String, System.Object> values

Values to add to list item
System.String folderPath

Optional folder path to add the item to.
FileSystemObjectType underlyingObjectType

Type of object to create. Defaults to File/ListItem
Returns
Task<IListItem>

Newly added list item

Contains(Int32)

Checks if the collection contains a listitem with a given id

Declaration
bool Contains(int id)
Parameters
System.Int32 id

Id to check for
Returns
System.Boolean

True if found, false otherwise

GetById(Int32, Expression<Func<IListItem, Object>>[])

Method to select a list item by Id

Declaration
IListItem GetById(int id, params Expression<Func<IListItem, object>>[] selectors)
Parameters
System.Int32 id

The Id to search for
Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select
Returns
IListItem

The resulting list item instance, if any

GetByIdAsync(Int32, Expression<Func<IListItem, Object>>[])

Method to select a list item by Id asynchronously

Declaration
Task<IListItem> GetByIdAsync(int id, params Expression<Func<IListItem, object>>[] selectors)
Parameters
System.Int32 id

The Id to search for
Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select
Returns
Task<IListItem>

The resulting list item instance, if any

RecycleById(Int32)

Recycle the list item

Declaration
Guid RecycleById(int id)
Parameters
System.Int32 id

Id of the item to recycle
Returns
Guid

RecycleByIdAsync(Int32)

Recycle the list item

Declaration
Task<Guid> RecycleByIdAsync(int id)
Parameters
System.Int32 id

Id of the item to recycle
Returns
Task<Guid>

RecycleByIdBatch(Batch, Int32)

Recycle the list item

Declaration
void RecycleByIdBatch(Batch batch, int id)
Parameters
Batch batch

Batch to add the request to
System.Int32 id

Id of the item to recycle

RecycleByIdBatch(Int32)

Recycle the list item

Declaration
void RecycleByIdBatch(int id)
Parameters
System.Int32 id

Id of the item to recycle

RecycleByIdBatchAsync(Batch, Int32)

Recycle the list item

Declaration
Task RecycleByIdBatchAsync(Batch batch, int id)
Parameters
Batch batch

Batch to add the request to
System.Int32 id

Id of the item to recycle
Returns
Task

RecycleByIdBatchAsync(Int32)

Recycle the list item

Declaration
Task RecycleByIdBatchAsync(int id)
Parameters
System.Int32 id

Id of the item to recycle
Returns
Task

Extension Methods