Interface IListCollection

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

Inherited Members

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IRequestableCollection.Requested

IRequestableCollection.Length

IRequestableCollection.RequestedItems

IRequestableCollection.Clear()

IDataModelCollectionLoad<IList>.LoadAsync(Expression<Func<IList, Object>>[])

IDataModelCollectionLoad<IList>.LoadBatchAsync(Batch, Expression<Func<IList, Object>>[])

IDataModelCollectionDeleteByGuidId.DeleteById(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdAsync(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Batch, Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Batch, Guid)

Namespace: PnP.Core.Model.SharePoint

Assembly: PnP.Core.dll

Syntax

public interface IListCollection : IDataModelCollection<IList>, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad<IList>, IDataModelCollectionDeleteByGuidId, ISupportModules<IListCollection>

Methods

Add(String, ListTemplateType)

Adds a new list

Declaration

IList Add(string title, ListTemplateType templateType)

Parameters

System.String title Title of the list

ListTemplateType templateType Template type

Returns

IList Newly added list

AddAsync(String, ListTemplateType)

Adds a new list

Declaration

Task<IList> AddAsync(string title, ListTemplateType templateType)

Parameters

System.String title Title of the list

ListTemplateType templateType Template type

Returns

Task<IList> Newly added list

AddBatch(Batch, String, ListTemplateType)

Adds a new list

Declaration

IList AddBatch(Batch batch, string title, ListTemplateType templateType)

Parameters

Batch batch Batch to use

System.String title Title of the list

ListTemplateType templateType Template type

Returns

IList Newly added list

AddBatch(String, ListTemplateType)

Adds a new list

Declaration

IList AddBatch(string title, ListTemplateType templateType)

Parameters

System.String title Title of the list

ListTemplateType templateType Template type

Returns

IList Newly added list

AddBatchAsync(Batch, String, ListTemplateType)

Adds a new list

Declaration

Task<IList> AddBatchAsync(Batch batch, string title, ListTemplateType templateType)

Parameters

Batch batch Batch to use

System.String title Title of the list

ListTemplateType templateType Template type

Returns

Task<IList> Newly added list

AddBatchAsync(String, ListTemplateType)

Adds a new list

Declaration

Task<IList> AddBatchAsync(string title, ListTemplateType templateType)

Parameters

System.String title Title of the list

ListTemplateType templateType Template type

Returns

Task<IList> Newly added list

EnsureSiteAssetsLibrary(Expression<Func<IList, Object>>[])

Ensures there's an Asset Library in the site, if not present it will be created

Declaration

IList EnsureSiteAssetsLibrary(params Expression<Func<IList, object>>[] selectors)

Parameters

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

IList The asset library

EnsureSiteAssetsLibraryAsync(Expression<Func<IList, Object>>[])

Ensures there's an Asset Library in the site, if not present it will be created

Declaration

Task<IList> EnsureSiteAssetsLibraryAsync(params Expression<Func<IList, object>>[] selectors)

Parameters

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

Task<IList> The asset library

EnsureSiteAssetsLibraryBatch(Expression<Func<IList, Object>>[])

Ensures there's an Asset Library in the site, if not present it will be created

Declaration

IList EnsureSiteAssetsLibraryBatch(params Expression<Func<IList, object>>[] selectors)

Parameters

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

IList The asset library

EnsureSiteAssetsLibraryBatch(Batch, Expression<Func<IList, Object>>[])

Ensures there's an Asset Library in the site, if not present it will be created

Declaration

IList EnsureSiteAssetsLibraryBatch(Batch batch, params Expression<Func<IList, object>>[] selectors)

Parameters

Batch batch Batch to add this request to

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

IList The asset library

EnsureSiteAssetsLibraryBatchAsync(Expression<Func<IList, Object>>[])

Ensures there's an Asset Library in the site, if not present it will be created

Declaration

Task<IList> EnsureSiteAssetsLibraryBatchAsync(params Expression<Func<IList, object>>[] selectors)

Parameters

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

Task<IList> The asset library

EnsureSiteAssetsLibraryBatchAsync(Batch, Expression<Func<IList, Object>>[])

Ensures there's an Asset Library in the site, if not present it will be created

Declaration

Task<IList> EnsureSiteAssetsLibraryBatchAsync(Batch batch, params Expression<Func<IList, object>>[] selectors)

Parameters

Batch batch Batch to add this request to

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

Task<IList> The asset library

GetById(Guid, Expression<Func<IList, Object>>[])

Method to select a list by id

Declaration

IList GetById(Guid id, params Expression<Func<IList, object>>[] selectors)

Parameters

Guid id The id to search for

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

IList The resulting list instance, if any

GetByIdAsync(Guid, Expression<Func<IList, Object>>[])

Method to select a list by id

Declaration

Task<IList> GetByIdAsync(Guid id, params Expression<Func<IList, object>>[] selectors)

Parameters

Guid id The id to search for

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

Task<IList> The resulting list instance, if any

GetByIdBatch(Guid, Expression<Func<IList, Object>>[])

Method to select a list by id

Declaration

IList GetByIdBatch(Guid id, params Expression<Func<IList, object>>[] selectors)

Parameters

Guid id The id to search for

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

IList The resulting list instance, if any

GetByIdBatch(Batch, Guid, Expression<Func<IList, Object>>[])

Method to select a list by id

Declaration

IList GetByIdBatch(Batch batch, Guid id, params Expression<Func<IList, object>>[] selectors)

Parameters

Batch batch Batch to add this request to

Guid id The id to search for

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

IList The resulting list instance, if any

GetByIdBatchAsync(Guid, Expression<Func<IList, Object>>[])

Method to select a list by id

Declaration

Task<IList> GetByIdBatchAsync(Guid id, params Expression<Func<IList, object>>[] selectors)

Parameters

Guid id The id to search for

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

Task<IList> The resulting list instance, if any

GetByIdBatchAsync(Batch, Guid, Expression<Func<IList, Object>>[])

Method to select a list by id

Declaration

Task<IList> GetByIdBatchAsync(Batch batch, Guid id, params Expression<Func<IList, object>>[] selectors)

Parameters

Batch batch Batch to add this request to

Guid id The id to search for

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

Task<IList> The resulting list instance, if any

GetByServerRelativeUrl(String, Expression<Func<IList, Object>>[])

Method to select a list by server relative url

Declaration

IList GetByServerRelativeUrl(string serverRelativeUrl, params Expression<Func<IList, object>>[] selectors)

Parameters

System.String serverRelativeUrl The server relative url of the list to return

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

IList The resulting list instance, if any

GetByServerRelativeUrlAsync(String, Expression<Func<IList, Object>>[])

Method to select a list by server relative url

Declaration

Task<IList> GetByServerRelativeUrlAsync(string serverRelativeUrl, params Expression<Func<IList, object>>[] selectors)

Parameters

System.String serverRelativeUrl The server relative url of the list to return

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

Task<IList> The resulting list instance, if any

GetByServerRelativeUrlBatch(Batch, String, Expression<Func<IList, Object>>[])

Method to select a list by server relative url

Declaration

IList GetByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression<Func<IList, object>>[] selectors)

Parameters

Batch batch Batch to add this request to

System.String serverRelativeUrl The server relative url of the list to return

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

IList The resulting list instance, if any

GetByServerRelativeUrlBatch(String, Expression<Func<IList, Object>>[])

Method to select a list by server relative url

Declaration

IList GetByServerRelativeUrlBatch(string serverRelativeUrl, params Expression<Func<IList, object>>[] selectors)

Parameters

System.String serverRelativeUrl The server relative url of the list to return

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

IList The resulting list instance, if any

GetByServerRelativeUrlBatchAsync(Batch, String, Expression<Func<IList, Object>>[])

Method to select a list by server relative url

Declaration

Task<IList> GetByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression<Func<IList, object>>[] selectors)

Parameters

Batch batch Batch to add this request to

System.String serverRelativeUrl The server relative url of the list to return

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

Task<IList> The resulting list instance, if any

GetByServerRelativeUrlBatchAsync(String, Expression<Func<IList, Object>>[])

Method to select a list by server relative url

Declaration

Task<IList> GetByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression<Func<IList, object>>[] selectors)

Parameters

System.String serverRelativeUrl The server relative url of the list to return

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

Task<IList> The resulting list instance, if any

GetByTitle(String, Expression<Func<IList, Object>>[])

Select a list by title

Declaration

IList GetByTitle(string title, params Expression<Func<IList, object>>[] selectors)

Parameters

System.String title The title to search for

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

IList The resulting list instance, if any

GetByTitleAsync(String, Expression<Func<IList, Object>>[])

Select a list by title

Declaration

Task<IList> GetByTitleAsync(string title, params Expression<Func<IList, object>>[] selectors)

Parameters

System.String title The title to search for

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

Task<IList> The resulting list instance, if any

GetByTitleBatch(Batch, String, Expression<Func<IList, Object>>[])

Select a list by title

Declaration

IList GetByTitleBatch(Batch batch, string title, params Expression<Func<IList, object>>[] selectors)

Parameters

Batch batch Batch to add this request to

System.String title The title to search for

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

IList The resulting list instance, if any

GetByTitleBatch(String, Expression<Func<IList, Object>>[])

Select a list by title

Declaration

IList GetByTitleBatch(string title, params Expression<Func<IList, object>>[] selectors)

Parameters

System.String title The title to search for

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

IList The resulting list instance, if any

GetByTitleBatchAsync(Batch, String, Expression<Func<IList, Object>>[])

Select a list by title

Declaration

Task<IList> GetByTitleBatchAsync(Batch batch, string title, params Expression<Func<IList, object>>[] selectors)

Parameters

Batch batch Batch to add this request to

System.String title The title to search for

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

Task<IList> The resulting list instance, if any

GetByTitleBatchAsync(String, Expression<Func<IList, Object>>[])

Select a list by title

Declaration

Task<IList> GetByTitleBatchAsync(string title, params Expression<Func<IList, object>>[] selectors)

Parameters

System.String title The title to search for

Expression<Func<IList, System.Object>>[] selectors The expressions declaring the fields to select

Returns

Task<IList> The resulting list instance, if any

Extension Methods

DataModelCollectionLoadExtensions.LoadBatchAsync<TModel>(IDataModelCollectionLoad<TModel>, Expression<Func<TModel, Object>>[])

DataModelCollectionLoadExtensions.LoadBatchAsync<TModel>(IDataModelCollectionLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])

DataModelCollectionLoadExtensions.LoadBatch<TModel>(IDataModelCollectionLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])

DataModelCollectionLoadExtensions.LoadBatch<TModel>(IDataModelCollectionLoad<TModel>, Expression<Func<TModel, Object>>[])

DataModelCollectionLoadExtensions.Load<TModel>(IDataModelCollectionLoad<TModel>, Expression<Func<TModel, Object>>[])

RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<String, String>, Action<Dictionary<String, String>>)

RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<String, String>>)

QueryableExtensions.AsRequested<TSource>(IDataModelCollection<TSource>)