Public interface to define a List object of SharePoint Online
public interface IList : IDataModel<IList>, IDataModelParent, IDataModelWithContext, ISupportModules<IList>, IDataModelGet<IList>, IDataModelLoad<IList>, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, ISecurableObject, IQueryableDataModelA special property used to add an asterisk to a $select statement
object All { get; }|
Object
|
Collection of content types for this list
IContentTypeCollection ContentTypes { get; }|
IContentTypeCollection
|
Gets or sets whether content types are enabled
bool ContentTypesEnabled { get; set; }|
Boolean
|
Defines a value that specifies the location of the default display form for the list.
string DefaultDisplayFormUrl { get; set; }|
String
|
Defines a value that specifies the URL of the edit form to use for list items in the list.
string DefaultEditFormUrl { get; set; }|
String
|
Defines a value that specifies the location of the default new form for the list.
string DefaultNewFormUrl { get; set; }|
String
|
Gets or sets the description of the list
string Description { get; set; }|
String
|
Defines a value that specifies the reading order of the list.
ListReadingDirection Direction { get; set; }|
ListReadingDirection
|
Gets or sets a value that specifies the identifier of the document template for the new list. SP REST property name: DocumentTemplateUrl.
string DocumentTemplate { get; set; }|
String
|
Gets or sets the DraftVersionVisibility for the list
int DraftVersionVisibility { get; set; }|
Int32
|
Gets or sets whether attachments are enabled. Defaults to true.
bool EnableAttachments { get; set; }|
Boolean
|
Gets or sets whether folder is enabled. Defaults to true.
bool EnableFolderCreation { get; set; }|
Boolean
|
Gets or sets whether minor verisioning is enabled on the list
bool EnableMinorVersions { get; set; }|
Boolean
|
Gets or sets whether moderation/content approval is enabled on the list
bool EnableModeration { get; set; }|
Boolean
|
Gets or sets whether verisioning is enabled on the list
bool EnableVersioning { get; set; }|
Boolean
|
Defines a list of default values for the Fields of the List Instance
Dictionary<string, string> FieldDefaults { get; }|
Dictionary<String, String>
|
Collection of fields for this list
IFieldCollection Fields { get; }|
IFieldCollection
|
Gets or sets whether to force checkout of documents in the library
bool ForceCheckout { get; set; }|
Boolean
|
The Unique ID of the List object
Guid Id { get; }|
Guid
|
Defines a value that specifies the URI for the icon of the list, optional attribute.
string ImageUrl { get; set; }|
String
|
Load the IRM settings of this list
IInformationRightsManagementSettings InformationRightsManagementSettings { get; }|
IInformationRightsManagementSettings
|
Defines if IRM is enabled for this list.
bool IrmEnabled { get; set; }|
Boolean
|
Defines if IRM Expire property, optional attribute.
bool IrmExpire { get; set; }|
Boolean
|
Defines the IRM Reject property, optional attribute.
bool IrmReject { get; set; }|
Boolean
|
Defines a value that specifies a flag that a client application can use to determine whether to display the list, optional attribute.
bool IsApplicationList { get; set; }|
Boolean
|
Gets a bool value that indicates whether the list is a gallery, such list templates, Web Parts, or Master Pages.
bool IsCatalog { get; }|
Boolean
|
Is this library the default document library of this site
bool IsDefaultDocumentLibrary { get; }|
Boolean
|
Gets a bool value that indicates whether the document library is a private list with restricted permissions, such as for Solutions
bool IsPrivate { get; }|
Boolean
|
Is this library the site's site asset library
bool IsSiteAssetsLibrary { get; }|
Boolean
|
Specifies whether the list is system list that does not contain end user data and created by system account.
bool IsSystemList { get; }|
Boolean
|
Collection of list items in the current List object
IListItemCollection Items { get; }|
IListItemCollection
|
Defines the current list UI/UX experience (valid for SPO only). SP REST property name: ListExperienceOptions.
ListExperience ListExperience { get; set; }|
ListExperience
|
The entity needed when updating list items
string ListItemEntityTypeFullName { get; }|
String
|
Gets or sets the MinorVersionLimit for verisioning, just in case it is enabled on the list SP REST property name: MajorVersionLimit.
int MaxVersionLimit { get; set; }|
Int32
|
Gets or sets the MinorVersionLimit for versioning, just in case it is enabled on the list SP REST property name: MajorWithMinorVersionsLimit.
int MinorVersionLimit { get; set; }|
Int32
|
Defines if the current list or library has to be included in crawling, optional attribute.
bool NoCrawl { get; set; }|
Boolean
|
Gets or sets a value that specifies whether the new list is displayed on the Quick Launch of the site.
bool OnQuickLaunch { get; set; }|
Boolean
|
Defines the Read Security property, optional attribute.
int ReadSecurity { get; set; }|
Int32
|
Gets or sets the Guid for TemplateFeature
Guid TemplateFeatureId { get; }|
Guid
|
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
ListTemplateType TemplateType { get; }|
ListTemplateType
|
Defines a value that specifies the data validation criteria for a list item, optional attribute.
string ValidationFormula { get; set; }|
String
|
Defines a value that specifies the error message returned when data validation fails for a list item, optional attribute.
string ValidationMessage { get; set; }|
String
|
Defines the Write Security property, optional attribute.
int WriteSecurity { get; set; }|
Int32
|
Adds a folder
IListItem AddListFolder(string path, string parentFolder = null, string contentTypeId = "0x0120")|
String
path
|
|
String
parentFolder
|
|
String
contentTypeId
|
|
IListItem
|
Adds a folder
Task<IListItem> AddListFolderAsync(string path, string parentFolder = null, string contentTypeId = "0x0120")|
String
path
|
|
String
parentFolder
|
|
String
contentTypeId
|
|
Task<IListItem>
|
Classifies and extracts all unprocessed files in the list
List<ISyntexClassifyAndExtractResult> ClassifyAndExtract(bool force = false, int pageSize = 500)|
Boolean
force
Also classify and extract files that were processed before |
|
Int32
pageSize
Page size used when loading the files in this library |
|
PnP.Core.Model.SharePoint.List<ISyntexClassifyAndExtractResult>
Information about the created classify and extract requests |
Classifies and extracts all unprocessed files in the list
Task<List<ISyntexClassifyAndExtractResult>> ClassifyAndExtractAsync(bool force = false, int pageSize = 500)|
Boolean
force
Also classify and extract files that were processed before |
|
Int32
pageSize
Page size used when loading the files in this library |
|
Task<PnP.Core.Model.SharePoint.List<ISyntexClassifyAndExtractResult>>
Information about the created classify and extract requests |
Classifies and extracts all unprocessed files in the list via the Syntex off-peak queue
ISyntexClassifyAndExtractResult ClassifyAndExtractOffPeak()|
ISyntexClassifyAndExtractResult
Information about the created classify and extract requests |
Classifies and extracts all unprocessed files in the list via the Syntex off-peak queue
Task<ISyntexClassifyAndExtractResult> ClassifyAndExtractOffPeakAsync()|
Task<ISyntexClassifyAndExtractResult>
Information about the created classify and extract requests |
Retrieves the compliance tag / retention label for this list
IComplianceTag GetComplianceTag()|
IComplianceTag
|
Retrieves the compliance tag / retention label for this list
Task<IComplianceTag> GetComplianceTagAsync()|
Task<IComplianceTag>
|
Loads list items based up on a CAML query
void LoadItemsByCamlQuery(CamlQueryOptions queryOptions, params Expression<Func<IListItem, object>>[] selectors)|
CamlQueryOptions
queryOptions
CamlQueryOptions defining the query to execute |
|
Expression<Func<IListItem, Object>>[]
selectors
The expressions declaring the fields to select |
Loads list items based up on a CAML query
void LoadItemsByCamlQuery(string query, params Expression<Func<IListItem, object>>[] selectors)|
String
query
query to execute |
|
Expression<Func<IListItem, Object>>[]
selectors
The expressions declaring the fields to select |
Loads list items based up on a CAML query
Task LoadItemsByCamlQueryAsync(CamlQueryOptions queryOptions, params Expression<Func<IListItem, object>>[] selectors)|
CamlQueryOptions
queryOptions
CamlQueryOptions defining the query to execute |
|
Expression<Func<IListItem, Object>>[]
selectors
The expressions declaring the fields to select |
|
Task
|
Loads list items based up on a CAML query
Task LoadItemsByCamlQueryAsync(string query, params Expression<Func<IListItem, object>>[] selectors)|
String
query
query to execute |
|
Expression<Func<IListItem, Object>>[]
selectors
The expressions declaring the fields to select |
|
Task
|
Loads list items based up on a CAML query
void LoadItemsByCamlQueryBatch(CamlQueryOptions queryOptions, params Expression<Func<IListItem, object>>[] selectors)|
CamlQueryOptions
queryOptions
CamlQueryOptions defining the query to execute |
|
Expression<Func<IListItem, Object>>[]
selectors
The expressions declaring the fields to select |
Loads list items based up on a CAML query
void LoadItemsByCamlQueryBatch(Batch batch, CamlQueryOptions queryOptions, params Expression<Func<IListItem, object>>[] selectors)|
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 |
Loads list items based up on a CAML query
void LoadItemsByCamlQueryBatch(Batch batch, string query, params Expression<Func<IListItem, object>>[] selectors)|
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 |
Loads list items based up on a CAML query
void LoadItemsByCamlQueryBatch(string query, params Expression<Func<IListItem, object>>[] selectors)|
String
query
query to execute |
|
Expression<Func<IListItem, Object>>[]
selectors
The expressions declaring the fields to select |
Loads list items based up on a CAML query
Task LoadItemsByCamlQueryBatchAsync(CamlQueryOptions queryOptions, params Expression<Func<IListItem, object>>[] selectors)|
CamlQueryOptions
queryOptions
CamlQueryOptions defining the query to execute |
|
Expression<Func<IListItem, Object>>[]
selectors
The expressions declaring the fields to select |
|
Task
|
Loads list items based up on a CAML query
Task LoadItemsByCamlQueryBatchAsync(Batch batch, CamlQueryOptions queryOptions, params Expression<Func<IListItem, object>>[] selectors)|
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 |
|
Task
|
Loads list items based up on a CAML query
Task LoadItemsByCamlQueryBatchAsync(Batch batch, string query, params Expression<Func<IListItem, object>>[] selectors)|
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 |
|
Task
|
Loads list items based up on a CAML query
Task LoadItemsByCamlQueryBatchAsync(string query, params Expression<Func<IListItem, object>>[] selectors)|
String
query
query to execute |
|
Expression<Func<IListItem, Object>>[]
selectors
The expressions declaring the fields to select |
|
Task
|
Loads list items based up on a CAML query and the RenderListDataAsStream API
Dictionary<string, object> LoadListDataAsStream(RenderListDataOptions renderOptions)|
RenderListDataOptions
renderOptions
RenderListDataOptions defining the query to execute |
|
Dictionary<String, Object>
|
Loads list items based up on a CAML query and the RenderListDataAsStream API
Task<Dictionary<string, object>> LoadListDataAsStreamAsync(RenderListDataOptions renderOptions)|
RenderListDataOptions
renderOptions
RenderListDataOptions defining the query to execute |
|
Task<Dictionary<String, Object>>
|
Moves this list into the site collection recycle bin, returns the recyle bin item id
Guid Recycle()|
Guid
Id of the recycle bin item |
Moves this list into the site collection recycle bin, returns the recyle bin item id
Task<Guid> RecycleAsync()|
Task<Guid>
Id of the recycle bin item |
Moves this list into the site collection recycle bin, returns the recyle bin item id
IBatchSingleResult<BatchResultValue<Guid>> RecycleBatch()|
IBatchSingleResult<BatchResultValue<Guid>>
Id of the recycle bin item |
Moves this list into the site collection recycle bin, returns the recyle bin item id
IBatchSingleResult<BatchResultValue<Guid>> RecycleBatch(Batch batch)|
Batch
batch
Batch to add the request to |
|
IBatchSingleResult<BatchResultValue<Guid>>
Id of the recycle bin item |
Moves this list into the site collection recycle bin, returns the recyle bin item id
Task<IBatchSingleResult<BatchResultValue<Guid>>> RecycleBatchAsync()|
Task<IBatchSingleResult<BatchResultValue<Guid>>>
Id of the recycle bin item |
Moves this list into the site collection recycle bin, returns the recyle bin item id
Task<IBatchSingleResult<BatchResultValue<Guid>>> RecycleBatchAsync(Batch batch)|
Batch
batch
Batch to add the request to |
|
Task<IBatchSingleResult<BatchResultValue<Guid>>>
Id of the recycle bin item |
Sets a compliance tag / retention label for this list
void SetComplianceTag(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)|
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 |
Sets a compliance tag / retention label for this list
Task SetComplianceTagAsync(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)|
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 |
|
Task
|
Sets a compliance tag / retention label for this list
void SetComplianceTagBatch(Batch batch, string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)|
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 |
Sets a compliance tag / retention label for this list
void SetComplianceTagBatch(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)|
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 |
Sets a compliance tag / retention label for this list
Task SetComplianceTagBatchAsync(Batch batch, string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)|
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 |
|
Task
|
Sets a compliance tag / retention label for this list
Task SetComplianceTagBatchAsync(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)|
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 |
|
Task
|