Interface IList

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

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, IQueryableDataModel

Inherited Members

IDataModel<IList>.Requested

IDataModel<IList>.HasValue(string)

IDataModel<IList>.HasChanged(string)

IDataModel<IList>.IsPropertyAvailable(Expression<Func<IList, object>>)

IDataModel<IList>.ArePropertiesAvailable(params Expression<Func<IList, object>>[])

IDataModel<IList>.EnsureProperties(params Expression<Func<IList, object>>[])

IDataModel<IList>.EnsurePropertiesAsync(params Expression<Func<IList, object>>[])

IDataModel<IList>.ExecuteRequestAsync(ApiRequest)

IDataModel<IList>.ExecuteRequest(ApiRequest)

IDataModel<IList>.ExecuteRequestBatchAsync(ApiRequest)

IDataModel<IList>.ExecuteRequestBatch(ApiRequest)

IDataModel<IList>.ExecuteRequestBatchAsync(Batch, ApiRequest)

IDataModel<IList>.ExecuteRequestBatch(Batch, ApiRequest)

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IDataModelGet<IList>.GetBatchAsync(Batch, params Expression<Func<IList, object>>[])

IDataModelGet<IList>.GetAsync(params Expression<Func<IList, object>>[])

IDataModelLoad<IList>.LoadBatchAsync(Batch, params Expression<Func<IList, object>>[])

IDataModelLoad<IList>.LoadAsync(params Expression<Func<IList, object>>[])

IDataModelUpdate.UpdateBatchAsync()

IDataModelUpdate.UpdateBatchAsync(Batch)

IDataModelUpdate.UpdateAsync()

IDataModelUpdate.UpdateBatch()

IDataModelUpdate.UpdateBatch(Batch)

IDataModelUpdate.Update()

IDataModelDelete.DeleteBatchAsync()

IDataModelDelete.DeleteBatchAsync(Batch)

IDataModelDelete.DeleteAsync()

IDataModelDelete.DeleteBatch()

IDataModelDelete.DeleteBatch(Batch)

IDataModelDelete.Delete()

IDataModelSupportingGetChanges.GetChangesAsync(ChangeQueryOptions)

IDataModelSupportingGetChanges.GetChanges(ChangeQueryOptions)

IDataModelSupportingGetChanges.GetChangesBatchAsync(Batch, ChangeQueryOptions)

IDataModelSupportingGetChanges.GetChangesBatch(Batch, ChangeQueryOptions)

IDataModelSupportingGetChanges.GetChangesBatchAsync(ChangeQueryOptions)

IDataModelSupportingGetChanges.GetChangesBatch(ChangeQueryOptions)

ISecurableObject.RoleAssignments

ISecurableObject.HasUniqueRoleAssignments

ISecurableObject.BreakRoleInheritance(bool, bool)

ISecurableObject.BreakRoleInheritanceAsync(bool, bool)

ISecurableObject.BreakRoleInheritanceBatch(Batch, bool, bool)

ISecurableObject.BreakRoleInheritanceBatchAsync(Batch, bool, bool)

ISecurableObject.BreakRoleInheritanceBatch(bool, bool)

ISecurableObject.BreakRoleInheritanceBatchAsync(bool, bool)

ISecurableObject.ResetRoleInheritance()

ISecurableObject.ResetRoleInheritanceAsync()

ISecurableObject.ResetRoleInheritanceBatch(Batch)

ISecurableObject.ResetRoleInheritanceBatchAsync(Batch)

ISecurableObject.ResetRoleInheritanceBatch()

ISecurableObject.ResetRoleInheritanceBatchAsync()

ISecurableObject.GetRoleDefinitions(int)

ISecurableObject.GetRoleDefinitionsAsync(int)

ISecurableObject.AddRoleDefinitions(int, params string[])

ISecurableObject.AddRoleDefinitionsAsync(int, params string[])

ISecurableObject.AddRoleDefinition(int, IRoleDefinition)

ISecurableObject.AddRoleDefinitionAsync(int, IRoleDefinition)

ISecurableObject.AddRoleDefinitionBatch(Batch, int, IRoleDefinition)

ISecurableObject.AddRoleDefinitionBatchAsync(Batch, int, IRoleDefinition)

ISecurableObject.AddRoleDefinitionBatch(int, IRoleDefinition)

ISecurableObject.AddRoleDefinitionBatchAsync(int, IRoleDefinition)

ISecurableObject.RemoveRoleDefinitions(int, params string[])

ISecurableObject.RemoveRoleDefinitionsAsync(int, params string[])

ISecurableObject.RemoveRoleDefinition(int, IRoleDefinition)

ISecurableObject.RemoveRoleDefinitionAsync(int, IRoleDefinition)

ISecurableObject.RemoveRoleDefinitionBatch(int, IRoleDefinition)

ISecurableObject.RemoveRoleDefinitionBatchAsync(int, IRoleDefinition)

ISecurableObject.RemoveRoleDefinitionBatch(Batch, int, IRoleDefinition)

ISecurableObject.RemoveRoleDefinitionBatchAsync(Batch, int, IRoleDefinition)

Extension Methods

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.Get<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.Load<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.QueryProperties<TModel>(IDataModelLoad<TModel>, params 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>>)

Properties

All

A special property used to add an asterisk to a $select statement

object All { get; }

Property Value

object

BaseType

Gets the base type for a list.

ListBaseType BaseType { get; }

Property Value

ListBaseType

ContentTypes

Collection of content types for this list Implements IQueryable<T>.
See Requesting model collections and IQueryable performance considerations to learn more.

IContentTypeCollection ContentTypes { get; }

Property Value

IContentTypeCollection

ContentTypesEnabled

Gets or sets whether content types are enabled

bool ContentTypesEnabled { get; set; }

Property Value

bool

Created

Specifies the date and time that the list was created.

DateTime Created { get; }

Property Value

DateTime

DefaultDisplayFormUrl

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

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.

string DefaultEditFormUrl { get; set; }

Property Value

string

DefaultItemOpenInBrowser

Gets or sets whether the item is opened by default using the browser.

bool DefaultItemOpenInBrowser { get; set; }

Property Value

bool

DefaultNewFormUrl

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

string DefaultNewFormUrl { get; set; }

Property Value

string

DefaultViewUrl

The url to the default view of this list.

string DefaultViewUrl { get; }

Property Value

string

Description

Gets or sets the description of the list

string Description { get; set; }

Property Value

string

Direction

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

ListReadingDirection Direction { get; set; }

Property Value

ListReadingDirection

DisableCommenting

Gets or sets whether comments are disabled. Defaults to false.

bool DisableCommenting { get; set; }

Property Value

bool

DocumentTemplate

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; }

Property Value

string

DraftVersionVisibility

Gets or sets the DraftVersionVisibility for the list

DraftVisibilityType DraftVersionVisibility { get; set; }

Property Value

DraftVisibilityType

EnableAttachments

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

bool EnableAttachments { get; set; }

Property Value

bool

EnableFolderCreation

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

bool EnableFolderCreation { get; set; }

Property Value

bool

EnableMinorVersions

Gets or sets whether minor verisioning is enabled on the list

bool EnableMinorVersions { get; set; }

Property Value

bool

EnableModeration

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

bool EnableModeration { get; set; }

Property Value

bool

EnableVersioning

Gets or sets whether verisioning is enabled on the list

bool EnableVersioning { get; set; }

Property Value

bool

EventReceivers

Event Receivers defined in this list Implements IQueryable<T>.
See Requesting model collections and IQueryable performance considerations to learn more.

IEventReceiverDefinitionCollection EventReceivers { get; }

Property Value

IEventReceiverDefinitionCollection

FieldDefaults

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

Dictionary<string, string> FieldDefaults { get; }

Property Value

Dictionary<string, string>

Fields

Collection of fields for this list Implements IQueryable<T>.
See Requesting model collections and IQueryable performance considerations to learn more.

IFieldCollection Fields { get; }

Property Value

IFieldCollection

ForceCheckout

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

bool ForceCheckout { get; set; }

Property Value

bool

Hidden

Gets or sets whether to hide the list

bool Hidden { get; set; }

Property Value

bool

Id

The Unique ID of the List object

Guid Id { get; }

Property Value

Guid

ImageUrl

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

string ImageUrl { get; set; }

Property Value

string

InformationRightsManagementSettings

Load the IRM settings of this list

IInformationRightsManagementSettings InformationRightsManagementSettings { get; }

Property Value

IInformationRightsManagementSettings

IrmEnabled

Defines if IRM is enabled for this list.

bool IrmEnabled { get; set; }

Property Value

bool

IrmExpire

Defines if IRM Expire property, optional attribute.

bool IrmExpire { get; set; }

Property Value

bool

IrmReject

Defines the IRM Reject property, optional attribute.

bool IrmReject { get; set; }

Property Value

bool

IsApplicationList

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; }

Property Value

bool

IsCatalog

Gets a bool value that indicates whether the list is a gallery, such list templates, Web Parts, or Master Pages.

bool IsCatalog { get; }

Property Value

bool

IsDefaultDocumentLibrary

Is this library the default document library of this site

bool IsDefaultDocumentLibrary { get; }

Property Value

bool

IsPrivate

Gets a bool value that indicates whether the document library is a private list with restricted permissions, such as for Solutions

bool IsPrivate { get; }

Property Value

bool

IsSiteAssetsLibrary

Is this library the site's site asset library

bool IsSiteAssetsLibrary { get; }

Property Value

bool

IsSystemList

Specifies whether the list is system list that does not contain end user data and created by system account.

bool IsSystemList { get; }

Property Value

bool

ItemCount

Number of items in the library

int ItemCount { get; }

Property Value

int

Items

Collection of list items in the current List object Implements IQueryable<T>.
See Requesting model collections and IQueryable performance considerations to learn more.

IListItemCollection Items { get; }

Property Value

IListItemCollection

LastItemDeletedDate

Specifies when an item in the list was last deleted. If no item has yet been deleted from the list the list creation time is returned.

DateTime LastItemDeletedDate { get; }

Property Value

DateTime

LastItemModifiedDate

Specifies when an item, field, or property of the list was last modified. If no item has been created in the list, the list creation time is returned.

DateTime LastItemModifiedDate { get; }

Property Value

DateTime

LastItemUserModifiedDate

Specifies when an item of the list was last modified by a non-system update. A non-system update is a change to a list item that is visible to users. If no item has been created in the list, the list creation time is returned.

DateTime LastItemUserModifiedDate { get; }

Property Value

DateTime

ListExperience

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

ListExperience ListExperience { get; set; }

Property Value

ListExperience

ListItemEntityTypeFullName

The entity needed when updating list items

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.

int MaxVersionLimit { get; set; }

Property Value

int

MinorVersionLimit

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; }

Property Value

int

NoCrawl

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

bool NoCrawl { get; set; }

Property Value

bool

OnQuickLaunch

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

bool OnQuickLaunch { get; set; }

Property Value

bool

ReadSecurity

Defines the Read Security property, optional attribute.

int ReadSecurity { get; set; }

Property Value

int

RootFolder

Gets the root folder of the list.

IFolder RootFolder { get; }

Property Value

IFolder

TemplateFeatureId

Gets or sets the Guid for TemplateFeature

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

ListTemplateType TemplateType { get; }

Property Value

ListTemplateType

Title

Gets or sets the list title

string Title { get; set; }

Property Value

string

UserCustomActions

Gets a value that specifies the collection of user custom actions for this list Implements IQueryable<T>.
See Requesting model collections and IQueryable performance considerations to learn more.

IUserCustomActionCollection UserCustomActions { get; }

Property Value

IUserCustomActionCollection

ValidationFormula

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

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.

string ValidationMessage { get; set; }

Property Value

string

Views

Get a list of the views Implements IQueryable<T>.
See Requesting model collections and IQueryable performance considerations to learn more.

IViewCollection Views { get; }

Property Value

IViewCollection

Webhooks

Collection of list webhooks Implements IQueryable<T>.
See Requesting model collections and IQueryable performance considerations to learn more.

IListSubscriptionCollection Webhooks { get; }

Property Value

IListSubscriptionCollection

WriteSecurity

Defines the Write Security property, optional attribute.

int WriteSecurity { get; set; }

Property Value

int

Methods

AddListFolder(string, string, string)

Adds a folder

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

Parameters

path string

parentFolder string

contentTypeId string

Returns

IListItem

AddListFolderAsync(string, string, string)

Adds a folder

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

Parameters

path string

parentFolder string

contentTypeId string

Returns

Task<IListItem>

AddListFolderBatch(Batch, string, string, string)

Adds a folder

IListItem AddListFolderBatch(Batch batch, string path, string parentFolder = null, string contentTypeId = "0x0120")

Parameters

batch Batch

Batch to add this request to

path string

parentFolder string

contentTypeId string

Returns

IListItem

AddListFolderBatch(string, string, string)

Adds a folder

IListItem AddListFolderBatch(string path, string parentFolder = null, string contentTypeId = "0x0120")

Parameters

path string

parentFolder string

contentTypeId string

Returns

IListItem

AddListFolderBatchAsync(Batch, string, string, string)

Adds a folder

Task<IListItem> AddListFolderBatchAsync(Batch batch, string path, string parentFolder = null, string contentTypeId = "0x0120")

Parameters

batch Batch

Batch to add this request to

path string

parentFolder string

contentTypeId string

Returns

Task<IListItem>

AddListFolderBatchAsync(string, string, string)

Adds a folder

Task<IListItem> AddListFolderBatchAsync(string path, string parentFolder = null, string contentTypeId = "0x0120")

Parameters

path string

parentFolder string

contentTypeId string

Returns

Task<IListItem>

CheckIfUserHasPermissions(string, PermissionKind)

Checks if a user has a specific kind of permissions to a list

bool CheckIfUserHasPermissions(string userPrincipalName, PermissionKind permissionKind)

Parameters

userPrincipalName string

Login name of the user you wish to check if he has a specific permission

permissionKind PermissionKind

Permission kind to check

Returns

bool

Boolean that says if the user has permissions or not

CheckIfUserHasPermissionsAsync(string, PermissionKind)

Checks if a user has a specific kind of permissions to a list

Task<bool> CheckIfUserHasPermissionsAsync(string userPrincipalName, PermissionKind permissionKind)

Parameters

userPrincipalName string

Login name of the user you wish to check if he has a specific permission

permissionKind PermissionKind

Permission kind to check

Returns

Task<bool>

Boolean that says if the user has permissions or not

ClassifyAndExtract(bool, int)

Classifies and extracts all unprocessed files in the list

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

Parameters

force bool

Also classify and extract files that were processed before

pageSize int

Page size used when loading the files in this library

Returns

List<ISyntexClassifyAndExtractResult>

Information about the created classify and extract requests

ClassifyAndExtractAsync(bool, int)

Classifies and extracts all unprocessed files in the list

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

Parameters

force bool

Also classify and extract files that were processed before

pageSize int

Page size used when loading the files in this library

Returns

Task<List<ISyntexClassifyAndExtractResult>>

Information about the created classify and extract requests

ClassifyAndExtractOffPeak()

Classifies and extracts all unprocessed files in the list via the Syntex off-peak queue

ISyntexClassifyAndExtractResult ClassifyAndExtractOffPeak()

Returns

ISyntexClassifyAndExtractResult

Information about the created classify and extract requests

ClassifyAndExtractOffPeakAsync()

Classifies and extracts all unprocessed files in the list via the Syntex off-peak queue

Task<ISyntexClassifyAndExtractResult> ClassifyAndExtractOffPeakAsync()

Returns

Task<ISyntexClassifyAndExtractResult>

Information about the created classify and extract requests

ClearDefaultColumnValues()

Clears the default column values set (at folder level) for this library

void ClearDefaultColumnValues()

ClearDefaultColumnValuesAsync()

Clears the default column values set (at folder level) for this library

Task ClearDefaultColumnValuesAsync()

Returns

Task

EnableAudienceTargeting()

Enable audience targeting for a list

void EnableAudienceTargeting()

EnableAudienceTargetingAsync()

Enable audience targeting for a list

Task EnableAudienceTargetingAsync()

Returns

Task

FindFiles(string)

Find files in the list, can be slow as it iterates over all the files in the list. If performance is key, then try using a search based solution

List<IFile> FindFiles(string match)

Parameters

match string

Returns

List<IFile>

A List<T> of found files as type IFile

FindFilesAsync(string)

Find files in the list, can be slow as it iterates over all the files in the list. If performance is key, then try using a search based solution

Task<List<IFile>> FindFilesAsync(string match)

Parameters

match string

Returns

Task<List<IFile>>

A List<T> of found files as type IFile

GetComplianceTag()

Retrieves the compliance tag / retention label for this list

IComplianceTag GetComplianceTag()

Returns

IComplianceTag

GetComplianceTagAsync()

Retrieves the compliance tag / retention label for this list

Task<IComplianceTag> GetComplianceTagAsync()

Returns

Task<IComplianceTag>

GetComplianceTagBatch()

Retrieves the compliance tag / retention label for this list

IBatchSingleResult<IComplianceTag> GetComplianceTagBatch()

Returns

IBatchSingleResult<IComplianceTag>

GetComplianceTagBatch(Batch)

Retrieves the compliance tag / retention label for this list

IBatchSingleResult<IComplianceTag> GetComplianceTagBatch(Batch batch)

Parameters

batch Batch

Batch to add this request to

Returns

IBatchSingleResult<IComplianceTag>

GetComplianceTagBatchAsync()

Retrieves the compliance tag / retention label for this list

Task<IBatchSingleResult<IComplianceTag>> GetComplianceTagBatchAsync()

Returns

Task<IBatchSingleResult<IComplianceTag>>

GetComplianceTagBatchAsync(Batch)

Retrieves the compliance tag / retention label for this list

Task<IBatchSingleResult<IComplianceTag>> GetComplianceTagBatchAsync(Batch batch)

Parameters

batch Batch

Batch to add this request to

Returns

Task<IBatchSingleResult<IComplianceTag>>

GetContentTypeOrder()

Returns the current list or content types in the current order

List<string> GetContentTypeOrder()

Returns

List<string>

Ordered list of content type id's, returns null when the list is not enabled to use content types

GetContentTypeOrderAsync()

Returns the current list or content types in the current order

Task<List<string>> GetContentTypeOrderAsync()

Returns

Task<List<string>>

Ordered list of content type id's, returns null when the list is not enabled to use content types

GetDefaultColumnValues()

Gets a list of default column values set (at folder level) for this library

List<DefaultColumnValueOptions> GetDefaultColumnValues()

Returns

List<DefaultColumnValueOptions>

List of default column values

GetDefaultColumnValuesAsync()

Gets a list of default column values set (at folder level) for this library

Task<List<DefaultColumnValueOptions>> GetDefaultColumnValuesAsync()

Returns

Task<List<DefaultColumnValueOptions>>

List of default column values

GetFlowInstances()

Returns a list of flow instances connected to this list

List<IFlowInstance> GetFlowInstances()

Returns

List<IFlowInstance>

List of connected flow instances

GetFlowInstancesAsync()

Returns a list of flow instances connected to this list

Task<List<IFlowInstance>> GetFlowInstancesAsync()

Returns

Task<List<IFlowInstance>>

List of connected flow instances

GetFlowInstancesBatch()

Returns a list of flow instances connected to this list

IEnumerableBatchResult<IFlowInstance> GetFlowInstancesBatch()

Returns

IEnumerableBatchResult<IFlowInstance>

List of connected flow instances

GetFlowInstancesBatch(Batch)

Returns a list of flow instances connected to this list

IEnumerableBatchResult<IFlowInstance> GetFlowInstancesBatch(Batch batch)

Parameters

batch Batch

Batch to add this request to

Returns

IEnumerableBatchResult<IFlowInstance>

List of connected flow instances

GetFlowInstancesBatchAsync()

Returns a list of flow instances connected to this list

Task<IEnumerableBatchResult<IFlowInstance>> GetFlowInstancesBatchAsync()

Returns

Task<IEnumerableBatchResult<IFlowInstance>>

List of connected flow instances

GetFlowInstancesBatchAsync(Batch)

Returns a list of flow instances connected to this list

Task<IEnumerableBatchResult<IFlowInstance>> GetFlowInstancesBatchAsync(Batch batch)

Parameters

batch Batch

Batch to add this request to

Returns

Task<IEnumerableBatchResult<IFlowInstance>>

List of connected flow instances

GetUserEffectivePermissions(string)

Gets the user effective permissions of a user for a list

IBasePermissions GetUserEffectivePermissions(string userPrincipalName)

Parameters

userPrincipalName string

Login name of the user you wish to retrieve the permissions of

Returns

IBasePermissions

Base permissions object that contains the High and the Low permissions

GetUserEffectivePermissionsAsync(string)

Gets the user effective permissions of a user for a list

Task<IBasePermissions> GetUserEffectivePermissionsAsync(string userPrincipalName)

Parameters

userPrincipalName string

Login name of the user you wish to retrieve the permissions of

Returns

Task<IBasePermissions>

Base permissions object that contains the High and the Low permissions

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

Loads list items based up on a CAML query

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

Parameters

queryOptions CamlQueryOptions

CamlQueryOptions defining the query to execute

selectors Expression<Func<IListItem, object>>[]

The expressions declaring the fields to select

LoadItemsByCamlQuery(string, params Expression<Func<IListItem, object>>[])

Loads list items based up on a CAML query

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

Parameters

query string

query to execute

selectors Expression<Func<IListItem, object>>[]

The expressions declaring the fields to select

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

Loads list items based up on a CAML query

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

Parameters

queryOptions CamlQueryOptions

CamlQueryOptions defining the query to execute

selectors Expression<Func<IListItem, object>>[]

The expressions declaring the fields to select

Returns

Task

LoadItemsByCamlQueryAsync(string, params Expression<Func<IListItem, object>>[])

Loads list items based up on a CAML query

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

Parameters

query string

query to execute

selectors Expression<Func<IListItem, object>>[]

The expressions declaring the fields to select

Returns

Task

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

Loads list items based up on a CAML query

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

Parameters

queryOptions CamlQueryOptions

CamlQueryOptions defining the query to execute

selectors Expression<Func<IListItem, object>>[]

The expressions declaring the fields to select

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

Loads list items based up on a CAML query

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

Parameters

batch Batch

Batch to add this request to

queryOptions CamlQueryOptions

CamlQueryOptions defining the query to execute

selectors Expression<Func<IListItem, object>>[]

The expressions declaring the fields to select

LoadItemsByCamlQueryBatch(Batch, string, params Expression<Func<IListItem, object>>[])

Loads list items based up on a CAML query

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

Parameters

batch Batch

Batch to add this request to

query string

query to execute

selectors Expression<Func<IListItem, object>>[]

The expressions declaring the fields to select

LoadItemsByCamlQueryBatch(string, params Expression<Func<IListItem, object>>[])

Loads list items based up on a CAML query

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

Parameters

query string

query to execute

selectors Expression<Func<IListItem, object>>[]

The expressions declaring the fields to select

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

Loads list items based up on a CAML query

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

Parameters

queryOptions CamlQueryOptions

CamlQueryOptions defining the query to execute

selectors Expression<Func<IListItem, object>>[]

The expressions declaring the fields to select

Returns

Task

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

Loads list items based up on a CAML query

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

Parameters

batch Batch

Batch to add this request to

queryOptions CamlQueryOptions

CamlQueryOptions defining the query to execute

selectors Expression<Func<IListItem, object>>[]

The expressions declaring the fields to select

Returns

Task

LoadItemsByCamlQueryBatchAsync(Batch, string, params Expression<Func<IListItem, object>>[])

Loads list items based up on a CAML query

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

Parameters

batch Batch

Batch to add this request to

query string

query to execute

selectors Expression<Func<IListItem, object>>[]

The expressions declaring the fields to select

Returns

Task

LoadItemsByCamlQueryBatchAsync(string, params Expression<Func<IListItem, object>>[])

Loads list items based up on a CAML query

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

Parameters

query string

query to execute

selectors Expression<Func<IListItem, object>>[]

The expressions declaring the fields to select

Returns

Task

LoadListDataAsStream(RenderListDataOptions)

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

Dictionary<string, object> LoadListDataAsStream(RenderListDataOptions renderOptions)

Parameters

renderOptions RenderListDataOptions

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

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

Parameters

renderOptions RenderListDataOptions

RenderListDataOptions defining the query to execute

Returns

Task<Dictionary<string, object>>

LoadListDataAsStreamBatch(RenderListDataOptions)

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

IBatchSingleResult<Dictionary<string, object>> LoadListDataAsStreamBatch(RenderListDataOptions renderOptions)

Parameters

renderOptions RenderListDataOptions

RenderListDataOptions defining the query to execute

Returns

IBatchSingleResult<Dictionary<string, object>>

LoadListDataAsStreamBatch(Batch, RenderListDataOptions)

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

IBatchSingleResult<Dictionary<string, object>> LoadListDataAsStreamBatch(Batch batch, RenderListDataOptions renderOptions)

Parameters

batch Batch

Batch to add this request to

renderOptions RenderListDataOptions

RenderListDataOptions defining the query to execute

Returns

IBatchSingleResult<Dictionary<string, object>>

LoadListDataAsStreamBatchAsync(RenderListDataOptions)

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

Task<IBatchSingleResult<Dictionary<string, object>>> LoadListDataAsStreamBatchAsync(RenderListDataOptions renderOptions)

Parameters

renderOptions RenderListDataOptions

RenderListDataOptions defining the query to execute

Returns

Task<IBatchSingleResult<Dictionary<string, object>>>

LoadListDataAsStreamBatchAsync(Batch, RenderListDataOptions)

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

Task<IBatchSingleResult<Dictionary<string, object>>> LoadListDataAsStreamBatchAsync(Batch batch, RenderListDataOptions renderOptions)

Parameters

batch Batch

Batch to add this request to

renderOptions RenderListDataOptions

RenderListDataOptions defining the query to execute

Returns

Task<IBatchSingleResult<Dictionary<string, object>>>

ReIndex()

Reindexes this list

void ReIndex()

ReIndexAsync()

Reindexes this list

Task ReIndexAsync()

Returns

Task

Recycle()

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

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

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

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

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

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

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

ReorderContentTypes(List<string>)

Reorders the content types on the list. This controls the order of content types in the "New" menu and "List Settings" page

void ReorderContentTypes(List<string> contentTypeIdList)

Parameters

contentTypeIdList List<string>

Ordered list of content type ids to set

ReorderContentTypesAsync(List<string>)

Reorders the content types on the list. This controls the order of content types in the "New" menu and "List Settings" page

Task ReorderContentTypesAsync(List<string> contentTypeIdList)

Parameters

contentTypeIdList List<string>

Ordered list of content type ids to set

Returns

Task

SetComplianceTag(string, bool, bool, bool)

Sets a compliance tag / retention label for this list

void SetComplianceTag(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)

Parameters

complianceTagValue string

Compliance tag

blockDelete bool

Prevent deletion of the list (Hold)

blockEdit bool

Prevent editing of the list (Record)

syncToItems bool

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

SetComplianceTagAsync(string, bool, bool, bool)

Sets a compliance tag / retention label for this list

Task SetComplianceTagAsync(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)

Parameters

complianceTagValue string

Compliance tag

blockDelete bool

Prevent deletion of the list (Hold)

blockEdit bool

Prevent editing of the list (Record)

syncToItems bool

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

Returns

Task

SetComplianceTagBatch(Batch, string, bool, bool, bool)

Sets a compliance tag / retention label for this list

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

Parameters

batch Batch

Batch to add this request to

complianceTagValue string

Compliance tag

blockDelete bool

Prevent deletion of the list (Hold)

blockEdit bool

Prevent editing of the list (Record)

syncToItems bool

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

SetComplianceTagBatch(string, bool, bool, bool)

Sets a compliance tag / retention label for this list

void SetComplianceTagBatch(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)

Parameters

complianceTagValue string

Compliance tag

blockDelete bool

Prevent deletion of the list (Hold)

blockEdit bool

Prevent editing of the list (Record)

syncToItems bool

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

SetComplianceTagBatchAsync(Batch, string, bool, bool, bool)

Sets a compliance tag / retention label for this list

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

Parameters

batch Batch

Batch to add this request to

complianceTagValue string

Compliance tag

blockDelete bool

Prevent deletion of the list (Hold)

blockEdit bool

Prevent editing of the list (Record)

syncToItems bool

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

Returns

Task

SetComplianceTagBatchAsync(string, bool, bool, bool)

Sets a compliance tag / retention label for this list

Task SetComplianceTagBatchAsync(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems)

Parameters

complianceTagValue string

Compliance tag

blockDelete bool

Prevent deletion of the list (Hold)

blockEdit bool

Prevent editing of the list (Record)

syncToItems bool

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

Returns

Task

SetDefaultColumnValues(List<DefaultColumnValueOptions>)

Sets the default column value settings (at folder level) for this library

void SetDefaultColumnValues(List<DefaultColumnValueOptions> defaultColumnValues)

Parameters

defaultColumnValues List<DefaultColumnValueOptions>

List with default column values to set

SetDefaultColumnValuesAsync(List<DefaultColumnValueOptions>)

Sets the default column value settings (at folder level) for this library

Task SetDefaultColumnValuesAsync(List<DefaultColumnValueOptions> defaultColumnValues)

Parameters

defaultColumnValues List<DefaultColumnValueOptions>

List with default column values to set

Returns

Task