Interface IList

Public interface to define a List object of SharePoint Online

Inherited Members
Namespace: PnP.Core.Model.SharePoint
Assembly: PnP.Core.dll
Syntax
public interface IList : IDataModel<IList>, IDataModelParent, IDataModelWithContext, IDataModelGet<IList>, IDataModelLoad<IList>, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, IQueryableDataModel

Properties

ContentTypes

Collection of content types for this list

Declaration
IContentTypeCollection ContentTypes { get; }
Property Value
IContentTypeCollection

ContentTypesEnabled

Gets or sets whether content types are enabled

Declaration
bool ContentTypesEnabled { get; set; }
Property Value
Boolean

DefaultDisplayFormUrl

Defines a value that specifies the location of the default display form for the list.

Declaration
string DefaultDisplayFormUrl { get; set; }
Property Value
String

DefaultEditFormUrl

Defines a value that specifies the URL of the edit form to use for list items in the list.

Declaration
string DefaultEditFormUrl { get; set; }
Property Value
String

DefaultNewFormUrl

Defines a value that specifies the location of the default new form for the list.

Declaration
string DefaultNewFormUrl { get; set; }
Property Value
String

Description

Gets or sets the description of the list

Declaration
string Description { get; set; }
Property Value
String

Direction

Defines a value that specifies the reading order of the list.

Declaration
ListReadingDirection Direction { get; set; }
Property Value
ListReadingDirection

DocumentTemplate

Gets or sets a value that specifies the identifier of the document template for the new list. SP REST property name: DocumentTemplateUrl.

Declaration
string DocumentTemplate { get; set; }
Property Value
String

DraftVersionVisibility

Gets or sets the DraftVersionVisibility for the list

Declaration
int DraftVersionVisibility { get; set; }
Property Value
Int32

EnableAttachments

Gets or sets whether attachments are enabled. Defaults to true.

Declaration
bool EnableAttachments { get; set; }
Property Value
Boolean

EnableFolderCreation

Gets or sets whether folder is enabled. Defaults to true.

Declaration
bool EnableFolderCreation { get; set; }
Property Value
Boolean

EnableMinorVersions

Gets or sets whether minor verisioning is enabled on the list

Declaration
bool EnableMinorVersions { get; set; }
Property Value
Boolean

EnableModeration

Gets or sets whether moderation/content approval is enabled on the list

Declaration
bool EnableModeration { get; set; }
Property Value
Boolean

EnableVersioning

Gets or sets whether verisioning is enabled on the list

Declaration
bool EnableVersioning { get; set; }
Property Value
Boolean

FieldDefaults

Defines a list of default values for the Fields of the List Instance

Declaration
Dictionary<string, string> FieldDefaults { get; }
Property Value
Dictionary<String, String>

Fields

Collection of fields for this list

Declaration
IFieldCollection Fields { get; }
Property Value
IFieldCollection

ForceCheckout

Gets or sets whether to force checkout of documents in the library

Declaration
bool ForceCheckout { get; set; }
Property Value
Boolean

HasUniqueRoleAssignments

Returns if the list has unique role assignments

Declaration
bool HasUniqueRoleAssignments { get; }
Property Value
Boolean

Hidden

Gets or sets whether to hide the list

Declaration
bool Hidden { get; set; }
Property Value
Boolean

Id

The Unique ID of the List object

Declaration
Guid Id { get; }
Property Value
Guid

ImageUrl

Defines a value that specifies the URI for the icon of the list, optional attribute.

Declaration
string ImageUrl { get; set; }
Property Value
String

InformationRightsManagementSettings

Load the IRM settings of this list

Declaration
IInformationRightsManagementSettings InformationRightsManagementSettings { get; }
Property Value
IInformationRightsManagementSettings

IrmEnabled

Defines if IRM is enabled for this list.

Declaration
bool IrmEnabled { get; set; }
Property Value
Boolean

IrmExpire

Defines if IRM Expire property, optional attribute.

Declaration
bool IrmExpire { get; set; }
Property Value
Boolean

IrmReject

Defines the IRM Reject property, optional attribute.

Declaration
bool IrmReject { get; set; }
Property Value
Boolean

IsApplicationList

Defines a value that specifies a flag that a client application can use to determine whether to display the list, optional attribute.

Declaration
bool IsApplicationList { get; set; }
Property Value
Boolean

Items

Collection of list items in the current List object

Declaration
IListItemCollection Items { get; }
Property Value
IListItemCollection

ListExperience

Defines the current list UI/UX experience (valid for SPO only). SP REST property name: ListExperienceOptions.

Declaration
ListExperience ListExperience { get; set; }
Property Value
ListExperience

ListItemEntityTypeFullName

The entity needed when updating list items

Declaration
string ListItemEntityTypeFullName { get; }
Property Value
String

MaxVersionLimit

Gets or sets the MinorVersionLimit for verisioning, just in case it is enabled on the list SP REST property name: MajorVersionLimit.

Declaration
int MaxVersionLimit { get; set; }
Property Value
Int32

MinorVersionLimit

Gets or sets the MinorVersionLimit for versioning, just in case it is enabled on the list SP REST property name: MajorWithMinorVersionsLimit.

Declaration
int MinorVersionLimit { get; set; }
Property Value
Int32

NoCrawl

Defines if the current list or library has to be included in crawling, optional attribute.

Declaration
bool NoCrawl { get; set; }
Property Value
Boolean

OnQuickLaunch

Gets or sets a value that specifies whether the new list is displayed on the Quick Launch of the site.

Declaration
bool OnQuickLaunch { get; set; }
Property Value
Boolean

ReadSecurity

Defines the Read Security property, optional attribute.

Declaration
int ReadSecurity { get; set; }
Property Value
Int32

RoleAssignments

Collection of role assignments for this list

Declaration
IRoleAssignmentCollection RoleAssignments { get; }
Property Value
IRoleAssignmentCollection

RootFolder

Gets the root folder of the list.

Declaration
IFolder RootFolder { get; }
Property Value
IFolder

TemplateFeatureId

Gets or sets the Guid for TemplateFeature

Declaration
Guid TemplateFeatureId { get; }
Property Value
Guid

TemplateType

Gets or sets a value that specifies the list server template of the new list. https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.listtemplatetype.aspx SP REST property name: BaseTemplate

Declaration
ListTemplateType TemplateType { get; }
Property Value
ListTemplateType

Title

Gets or sets the list title

Declaration
string Title { get; set; }
Property Value
String

ValidationFormula

Defines a value that specifies the data validation criteria for a list item, optional attribute.

Declaration
string ValidationFormula { get; set; }
Property Value
String

ValidationMessage

Defines a value that specifies the error message returned when data validation fails for a list item, optional attribute.

Declaration
string ValidationMessage { get; set; }
Property Value
String

Views

Get a list of the views

Declaration
IViewCollection Views { get; }
Property Value
IViewCollection

WriteSecurity

Defines the Write Security property, optional attribute.

Declaration
int WriteSecurity { get; set; }
Property Value
Int32

Methods

AddListFolder(String, String, String)

Adds a folder

Declaration
IListItem AddListFolder(string path, string parentFolder = null, string contentTypeId = "0x0120")
Parameters
String path

String parentFolder

String contentTypeId

Returns
IListItem

AddListFolderAsync(String, String, String)

Adds a folder

Declaration
Task<IListItem> AddListFolderAsync(string path, string parentFolder = null, string contentTypeId = "0x0120")
Parameters
String path

String parentFolder

String contentTypeId

Returns
Task<IListItem>

AddRoleDefinitions(Int32, String[])

Add role definitions for a specific principal id (IUser.Id or ISharePointGroup.Id)

Declaration
bool AddRoleDefinitions(int principalId, params string[] names)
Parameters
Int32 principalId

String[] names

Returns
Boolean

AddRoleDefinitionsAsync(Int32, String[])

Adds role definitions for a specific principal id (IUser.Id or ISharePointGroup.Id)

Declaration
Task<bool> AddRoleDefinitionsAsync(int principalId, params string[] names)
Parameters
Int32 principalId

String[] names

Returns
Task<Boolean>

BreakRoleInheritance(Boolean, Boolean)

Creates unique role assignments for the list.

Declaration
void BreakRoleInheritance(bool copyRoleAssignments, bool clearSubscopes)
Parameters
Boolean copyRoleAssignments

Specifies whether to copy the role assignments from the parent securable object. If the value is false, the collection of role assignments must contain only 1 role assignment containing the current user after the operation.
Boolean clearSubscopes

If the securable object is a site, and the clearsubscopes parameter is true, the role assignments for all child securable objects in the current site and in the sites which inherit role assignments from the current site must be cleared and those securable objects will inherit role assignments from the current site after this call. If the securable object is a site, and the clearsubscopes parameter is false, the role assignments for all child securable objects which do not inherit role assignments from their parent object must remain unchanged. If the securable object is not a site, and the clearsubscopes parameter is true, the role assignments for all child securable objects must be cleared and those securable objects will inherit role assignments from the current securable object after this call. If the securable object is not a site, and the clearsubscopes parameter is false, the role assignments for all child securable objects which do not inherit role assignments from their parent object must remain unchanged.

BreakRoleInheritanceAsync(Boolean, Boolean)

Creates unique role assignments for the list.

Declaration
Task BreakRoleInheritanceAsync(bool copyRoleAssignments, bool clearSubscopes)
Parameters
Boolean copyRoleAssignments

Specifies whether to copy the role assignments from the parent securable object. If the value is false, the collection of role assignments must contain only 1 role assignment containing the current user after the operation.
Boolean clearSubscopes

If the securable object is a site, and the clearsubscopes parameter is true, the role assignments for all child securable objects in the current site and in the sites which inherit role assignments from the current site must be cleared and those securable objects will inherit role assignments from the current site after this call. If the securable object is a site, and the clearsubscopes parameter is false, the role assignments for all child securable objects which do not inherit role assignments from their parent object must remain unchanged. If the securable object is not a site, and the clearsubscopes parameter is true, the role assignments for all child securable objects must be cleared and those securable objects will inherit role assignments from the current securable object after this call. If the securable object is not a site, and the clearsubscopes parameter is false, the role assignments for all child securable objects which do not inherit role assignments from their parent object must remain unchanged.
Returns
Task

ClassifyAndExtract(Boolean, Int32)

Classifies and extracts all unprocessed files in the list

Declaration
List<ISyntexClassifyAndExtractResult> ClassifyAndExtract(bool force = false, int pageSize = 500)
Parameters
Boolean force

Also classify and extract files that were processed before
Int32 pageSize

Page size used when loading the files in this library
Returns
PnP.Core.Model.SharePoint.List<ISyntexClassifyAndExtractResult>

Information about the created classify and extract requests

ClassifyAndExtractAsync(Boolean, Int32)

Classifies and extracts all unprocessed files in the list

Declaration
Task<List<ISyntexClassifyAndExtractResult>> ClassifyAndExtractAsync(bool force = false, int pageSize = 500)
Parameters
Boolean force

Also classify and extract files that were processed before
Int32 pageSize

Page size used when loading the files in this library
Returns
Task<PnP.Core.Model.SharePoint.List<ISyntexClassifyAndExtractResult>>

Information about the created classify and extract requests

GetComplianceTag()

Retrieves the compliance tag / retention label for this list

Declaration
IComplianceTag GetComplianceTag()
Returns
IComplianceTag

GetComplianceTagAsync()

Retrieves the compliance tag / retention label for this list

Declaration
Task<IComplianceTag> GetComplianceTagAsync()
Returns
Task<IComplianceTag>

GetRoleDefinitions(Int32)

Returns the role definitions for a specific principal id (IUser.Id or ISharePointGroup.Id)

Declaration
IRoleDefinitionCollection GetRoleDefinitions(int principalId)
Parameters
Int32 principalId

Returns
IRoleDefinitionCollection

GetRoleDefinitionsAsync(Int32)

Returns the role definitions for a specific principal id (IUser.Id or ISharePointGroup.Id)

Declaration
Task<IRoleDefinitionCollection> GetRoleDefinitionsAsync(int principalId)
Parameters
Int32 principalId

Returns
Task<IRoleDefinitionCollection>

LoadItemsByCamlQuery(CamlQueryOptions, Expression<Func<IListItem, Object>>[])

Loads list items based up on a CAML query

Declaration
void LoadItemsByCamlQuery(CamlQueryOptions queryOptions, params Expression<Func<IListItem, object>>[] selectors)
Parameters
CamlQueryOptions queryOptions

CamlQueryOptions defining the query to execute
Expression<Func<IListItem, Object>>[] selectors

The expressions declaring the fields to select

LoadItemsByCamlQuery(String, Expression<Func<IListItem, Object>>[])

Loads list items based up on a CAML query

Declaration
void LoadItemsByCamlQuery(string query, params Expression<Func<IListItem, object>>[] selectors)
Parameters
String query

query to execute
Expression<Func<IListItem, Object>>[] selectors

The expressions declaring the fields to select

LoadItemsByCamlQueryAsync(CamlQueryOptions, Expression<Func<IListItem, Object>>[])

Loads list items based up on a CAML query

Declaration
Task LoadItemsByCamlQueryAsync(CamlQueryOptions queryOptions, params Expression<Func<IListItem, object>>[] selectors)
Parameters
CamlQueryOptions queryOptions

CamlQueryOptions defining the query to execute
Expression<Func<IListItem, Object>>[] selectors

The expressions declaring the fields to select
Returns
Task

LoadItemsByCamlQueryAsync(String, Expression<Func<IListItem, Object>>[])

Loads list items based up on a CAML query

Declaration
Task LoadItemsByCamlQueryAsync(string query, params Expression<Func<IListItem, object>>[] selectors)
Parameters
String query

query to execute
Expression<Func<IListItem, Object>>[] selectors

The expressions declaring the fields to select
Returns
Task

LoadItemsByCamlQueryBatch(CamlQueryOptions, Expression<Func<IListItem, Object>>[])

Loads list items based up on a CAML query

Declaration
void LoadItemsByCamlQueryBatch(CamlQueryOptions queryOptions, params Expression<Func<IListItem, object>>[] selectors)
Parameters
CamlQueryOptions queryOptions

CamlQueryOptions defining the query to execute
Expression<Func<IListItem, Object>>[] selectors

The expressions declaring the fields to select

LoadItemsByCamlQueryBatch(Batch, CamlQueryOptions, Expression<Func<IListItem, Object>>[])

Loads list items based up on a CAML query

Declaration
void LoadItemsByCamlQueryBatch(Batch batch, CamlQueryOptions queryOptions, params Expression<Func<IListItem, object>>[] selectors)
Parameters
Batch batch

Batch to add this request to
CamlQueryOptions queryOptions

CamlQueryOptions defining the query to execute
Expression<Func<IListItem, Object>>[] selectors

The expressions declaring the fields to select

LoadItemsByCamlQueryBatch(Batch, String, Expression<Func<IListItem, Object>>[])

Loads list items based up on a CAML query

Declaration
void LoadItemsByCamlQueryBatch(Batch batch, string query, params Expression<Func<IListItem, object>>[] selectors)
Parameters
Batch batch

Batch to add this request to
String query

query to execute
Expression<Func<IListItem, Object>>[] selectors

The expressions declaring the fields to select

LoadItemsByCamlQueryBatch(String, Expression<Func<IListItem, Object>>[])

Loads list items based up on a CAML query

Declaration
void LoadItemsByCamlQueryBatch(string query, params Expression<Func<IListItem, object>>[] selectors)
Parameters
String query

query to execute
Expression<Func<IListItem, Object>>[] selectors

The expressions declaring the fields to select

LoadItemsByCamlQueryBatchAsync(CamlQueryOptions, Expression<Func<IListItem, Object>>[])

Loads list items based up on a CAML query

Declaration
Task LoadItemsByCamlQueryBatchAsync(CamlQueryOptions queryOptions, params Expression<Func<IListItem, object>>[] selectors)
Parameters
CamlQueryOptions queryOptions

CamlQueryOptions defining the query to execute
Expression<Func<IListItem, Object>>[] selectors

The expressions declaring the fields to select
Returns
Task

LoadItemsByCamlQueryBatchAsync(Batch, CamlQueryOptions, Expression<Func<IListItem, Object>>[])

Loads list items based up on a CAML query

Declaration
Task LoadItemsByCamlQueryBatchAsync(Batch batch, CamlQueryOptions queryOptions, params Expression<Func<IListItem, object>>[] selectors)
Parameters
Batch batch

Batch to add this request to
CamlQueryOptions queryOptions

CamlQueryOptions defining the query to execute
Expression<Func<IListItem, Object>>[] selectors

The expressions declaring the fields to select
Returns
Task

LoadItemsByCamlQueryBatchAsync(Batch, String, Expression<Func<IListItem, Object>>[])

Loads list items based up on a CAML query

Declaration
Task LoadItemsByCamlQueryBatchAsync(Batch batch, string query, params Expression<Func<IListItem, object>>[] selectors)
Parameters
Batch batch

Batch to add this request to
String query

query to execute
Expression<Func<IListItem, Object>>[] selectors

The expressions declaring the fields to select
Returns
Task

LoadItemsByCamlQueryBatchAsync(String, Expression<Func<IListItem, Object>>[])

Loads list items based up on a CAML query

Declaration
Task LoadItemsByCamlQueryBatchAsync(string query, params Expression<Func<IListItem, object>>[] selectors)
Parameters
String query

query to execute
Expression<Func<IListItem, Object>>[] selectors

The expressions declaring the fields to select
Returns
Task

LoadListDataAsStream(RenderListDataOptions)

Loads list items based up on a CAML query and the RenderListDataAsStream API

Declaration
Dictionary<string, object> LoadListDataAsStream(RenderListDataOptions renderOptions)
Parameters
RenderListDataOptions renderOptions

RenderListDataOptions defining the query to execute
Returns
Dictionary<String, Object>

LoadListDataAsStreamAsync(RenderListDataOptions)

Loads list items based up on a CAML query and the RenderListDataAsStream API

Declaration
Task<Dictionary<string, object>> LoadListDataAsStreamAsync(RenderListDataOptions renderOptions)
Parameters
RenderListDataOptions renderOptions

RenderListDataOptions defining the query to execute
Returns
Task<Dictionary<String, Object>>

Recycle()

Moves this list into the site collection recycle bin, returns the recyle bin item id

Declaration
Guid Recycle()
Returns
Guid

Id of the recycle bin item

RecycleAsync()

Moves this list into the site collection recycle bin, returns the recyle bin item id

Declaration
Task<Guid> RecycleAsync()
Returns
Task<Guid>

Id of the recycle bin item

RecycleBatch()

Moves this list into the site collection recycle bin, returns the recyle bin item id

Declaration
IBatchSingleResult<BatchResultValue<Guid>> RecycleBatch()
Returns
IBatchSingleResult<BatchResultValue<Guid>>

Id of the recycle bin item

RecycleBatch(Batch)

Moves this list into the site collection recycle bin, returns the recyle bin item id

Declaration
IBatchSingleResult<BatchResultValue<Guid>> RecycleBatch(Batch batch)
Parameters
Batch batch

Batch to add the request to
Returns
IBatchSingleResult<BatchResultValue<Guid>>

Id of the recycle bin item

RecycleBatchAsync()

Moves this list into the site collection recycle bin, returns the recyle bin item id

Declaration
Task<IBatchSingleResult<BatchResultValue<Guid>>> RecycleBatchAsync()
Returns
Task<IBatchSingleResult<BatchResultValue<Guid>>>

Id of the recycle bin item

RecycleBatchAsync(Batch)

Moves this list into the site collection recycle bin, returns the recyle bin item id

Declaration
Task<IBatchSingleResult<BatchResultValue<Guid>>> RecycleBatchAsync(Batch batch)
Parameters
Batch batch

Batch to add the request to
Returns
Task<IBatchSingleResult<BatchResultValue<Guid>>>

Id of the recycle bin item

RemoveRoleDefinitions(Int32, String[])

Adds role definitions for a specific principal id (IUser.Id or ISharePointGroup.Id)

Declaration
bool RemoveRoleDefinitions(int principalId, params string[] names)
Parameters
Int32 principalId

String[] names

Returns
Boolean

RemoveRoleDefinitionsAsync(Int32, String[])

adds role definitions for a specific principal id (IUser.Id or ISharePointGroup.Id)

Declaration
Task<bool> RemoveRoleDefinitionsAsync(int principalId, params string[] names)
Parameters
Int32 principalId

String[] names

Returns
Task<Boolean>

ResetRoleInheritance()

Removes the local role assignments so that the list, and all its descendant objects, re-inherit role assignments from the parent object.

Declaration
void ResetRoleInheritance()

ResetRoleInheritanceAsync()

Removes the local role assignments so that the list, and all its descendant objects, re-inherit role assignments from the parent object.

Declaration
Task ResetRoleInheritanceAsync()
Returns
Task

SetComplianceTag(String, Boolean, Boolean, Boolean)

Sets a compliance tag / retention label for this list

Declaration
void SetComplianceTag(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)
Parameters
String complianceTagValue

Compliance tag
Boolean blockDelete

Prevent deletion of the list (Hold)
Boolean blockEdit

Prevent editing of the list (Record)
Boolean syncToItems

If true the compliance tag is synced to the list items in this list

SetComplianceTagAsync(String, Boolean, Boolean, Boolean)

Sets a compliance tag / retention label for this list

Declaration
Task SetComplianceTagAsync(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)
Parameters
String complianceTagValue

Compliance tag
Boolean blockDelete

Prevent deletion of the list (Hold)
Boolean blockEdit

Prevent editing of the list (Record)
Boolean syncToItems

If true the compliance tag is synced to the list items in this list
Returns
Task

SetComplianceTagBatch(Batch, String, Boolean, Boolean, Boolean)

Sets a compliance tag / retention label for this list

Declaration
void SetComplianceTagBatch(Batch batch, string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)
Parameters
Batch batch

Batch to add this request to
String complianceTagValue

Compliance tag
Boolean blockDelete

Prevent deletion of the list (Hold)
Boolean blockEdit

Prevent editing of the list (Record)
Boolean syncToItems

If true the compliance tag is synced to the list items in this list

SetComplianceTagBatch(String, Boolean, Boolean, Boolean)

Sets a compliance tag / retention label for this list

Declaration
void SetComplianceTagBatch(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)
Parameters
String complianceTagValue

Compliance tag
Boolean blockDelete

Prevent deletion of the list (Hold)
Boolean blockEdit

Prevent editing of the list (Record)
Boolean syncToItems

If true the compliance tag is synced to the list items in this list

SetComplianceTagBatchAsync(Batch, String, Boolean, Boolean, Boolean)

Sets a compliance tag / retention label for this list

Declaration
Task SetComplianceTagBatchAsync(Batch batch, string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)
Parameters
Batch batch

Batch to add this request to
String complianceTagValue

Compliance tag
Boolean blockDelete

Prevent deletion of the list (Hold)
Boolean blockEdit

Prevent editing of the list (Record)
Boolean syncToItems

If true the compliance tag is synced to the list items in this list
Returns
Task

SetComplianceTagBatchAsync(String, Boolean, Boolean, Boolean)

Sets a compliance tag / retention label for this list

Declaration
Task SetComplianceTagBatchAsync(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)
Parameters
String complianceTagValue

Compliance tag
Boolean blockDelete

Prevent deletion of the list (Hold)
Boolean blockEdit

Prevent editing of the list (Record)
Boolean syncToItems

If true the compliance tag is synced to the list items in this list
Returns
Task

Extension Methods