Interface IListCollection

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

Inherited Members
Namespace: PnP.Core.Model.SharePoint
Assembly: PnP.Core.dll
Syntax
public interface IListCollection : IQueryable<IList>, IQueryable, IAsyncEnumerable<IList>, IDataModelCollection<IList>, IEnumerable<IList>, IEnumerable, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad<IList>, IDataModelCollectionDeleteByGuidId, ISupportModules<IListCollection>

Methods

Add(string, ListTemplateType)

Adds a new list

Declaration
IList Add(string title, ListTemplateType templateType)
Parameters
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
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
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
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
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
string title

Title of the list
ListTemplateType templateType

Template type
Returns
Task<IList>

Newly added list

EnsureSiteAssetsLibrary(params 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, object>>[] selectors

The expressions declaring the fields to select
Returns
IList

The asset library

EnsureSiteAssetsLibraryAsync(params 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, object>>[] selectors

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

The asset library

EnsureSiteAssetsLibraryBatch(Batch, params 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, object>>[] selectors

The expressions declaring the fields to select
Returns
IList

The asset library

EnsureSiteAssetsLibraryBatch(params 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, object>>[] selectors

The expressions declaring the fields to select
Returns
IList

The asset library

EnsureSiteAssetsLibraryBatchAsync(Batch, params 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, object>>[] selectors

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

The asset library

EnsureSiteAssetsLibraryBatchAsync(params 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, object>>[] selectors

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

The asset library

GetById(Guid, params 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, object>>[] selectors

The expressions declaring the fields to select
Returns
IList

The resulting list instance, if any

GetByIdAsync(Guid, params 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, object>>[] selectors

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

The resulting list instance, if any

GetByIdBatch(Batch, Guid, params 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, object>>[] selectors

The expressions declaring the fields to select
Returns
IList

The resulting list instance, if any

GetByIdBatch(Guid, params 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, object>>[] selectors

The expressions declaring the fields to select
Returns
IList

The resulting list instance, if any

GetByIdBatchAsync(Batch, Guid, params 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, object>>[] selectors

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

The resulting list instance, if any

GetByIdBatchAsync(Guid, params 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, object>>[] selectors

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

The resulting list instance, if any

GetByServerRelativeUrl(string, params 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
string serverRelativeUrl

The server relative url of the list to return
Expression<Func<IList, object>>[] selectors

The expressions declaring the fields to select
Returns
IList

The resulting list instance, if any

GetByServerRelativeUrlAsync(string, params 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
string serverRelativeUrl

The server relative url of the list to return
Expression<Func<IList, object>>[] selectors

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

The resulting list instance, if any

GetByServerRelativeUrlBatch(Batch, string, params 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
string serverRelativeUrl

The server relative url of the list to return
Expression<Func<IList, object>>[] selectors

The expressions declaring the fields to select
Returns
IList

The resulting list instance, if any

GetByServerRelativeUrlBatch(string, params 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
string serverRelativeUrl

The server relative url of the list to return
Expression<Func<IList, object>>[] selectors

The expressions declaring the fields to select
Returns
IList

The resulting list instance, if any

GetByServerRelativeUrlBatchAsync(Batch, string, params 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
string serverRelativeUrl

The server relative url of the list to return
Expression<Func<IList, object>>[] selectors

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

The resulting list instance, if any

GetByServerRelativeUrlBatchAsync(string, params 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
string serverRelativeUrl

The server relative url of the list to return
Expression<Func<IList, object>>[] selectors

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

The resulting list instance, if any

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

Select a list by title

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

The title to search for
Expression<Func<IList, object>>[] selectors

The expressions declaring the fields to select
Returns
IList

The resulting list instance, if any

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

Select a list by title

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

The title to search for
Expression<Func<IList, object>>[] selectors

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

The resulting list instance, if any

GetByTitleBatch(Batch, string, params 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
string title

The title to search for
Expression<Func<IList, object>>[] selectors

The expressions declaring the fields to select
Returns
IList

The resulting list instance, if any

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

Select a list by title

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

The title to search for
Expression<Func<IList, object>>[] selectors

The expressions declaring the fields to select
Returns
IList

The resulting list instance, if any

GetByTitleBatchAsync(Batch, string, params 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
string title

The title to search for
Expression<Func<IList, object>>[] selectors

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

The resulting list instance, if any

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

Select a list by title

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

The title to search for
Expression<Func<IList, object>>[] selectors

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

The resulting list instance, if any

Extension Methods