Search Results for

    Show / Hide Table of Contents

    Interface IList

    Public interface to define a List object of SharePoint Online

    Inherited Members
    IDataModel<IList>.Requested
    IDataModel<IList>.HasValue(String)
    IDataModel<IList>.HasChanged(String)
    IDataModel<IList>.IsPropertyAvailable(Expression<Func<IList, Object>>)
    IDataModel<IList>.ArePropertiesAvailable(Expression<Func<IList, Object>>[])
    IDataModel<IList>.EnsureProperties(Expression<Func<IList, Object>>[])
    IDataModel<IList>.EnsurePropertiesAsync(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, Expression<Func<IList, Object>>[])
    IDataModelGet<IList>.GetAsync(Expression<Func<IList, Object>>[])
    IDataModelLoad<IList>.LoadBatchAsync(Batch, Expression<Func<IList, Object>>[])
    IDataModelLoad<IList>.LoadAsync(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(Boolean, Boolean)
    ISecurableObject.BreakRoleInheritanceAsync(Boolean, Boolean)
    ISecurableObject.BreakRoleInheritanceBatch(Batch, Boolean, Boolean)
    ISecurableObject.BreakRoleInheritanceBatchAsync(Batch, Boolean, Boolean)
    ISecurableObject.BreakRoleInheritanceBatch(Boolean, Boolean)
    ISecurableObject.BreakRoleInheritanceBatchAsync(Boolean, Boolean)
    ISecurableObject.ResetRoleInheritance()
    ISecurableObject.ResetRoleInheritanceAsync()
    ISecurableObject.ResetRoleInheritanceBatch(Batch)
    ISecurableObject.ResetRoleInheritanceBatchAsync(Batch)
    ISecurableObject.ResetRoleInheritanceBatch()
    ISecurableObject.ResetRoleInheritanceBatchAsync()
    ISecurableObject.GetRoleDefinitions(Int32)
    ISecurableObject.GetRoleDefinitionsAsync(Int32)
    ISecurableObject.AddRoleDefinitions(Int32, String[])
    ISecurableObject.AddRoleDefinitionsAsync(Int32, String[])
    ISecurableObject.AddRoleDefinition(Int32, IRoleDefinition)
    ISecurableObject.AddRoleDefinitionAsync(Int32, IRoleDefinition)
    ISecurableObject.AddRoleDefinitionBatch(Batch, Int32, IRoleDefinition)
    ISecurableObject.AddRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition)
    ISecurableObject.AddRoleDefinitionBatch(Int32, IRoleDefinition)
    ISecurableObject.AddRoleDefinitionBatchAsync(Int32, IRoleDefinition)
    ISecurableObject.RemoveRoleDefinitions(Int32, String[])
    ISecurableObject.RemoveRoleDefinitionsAsync(Int32, String[])
    ISecurableObject.RemoveRoleDefinition(Int32, IRoleDefinition)
    ISecurableObject.RemoveRoleDefinitionAsync(Int32, IRoleDefinition)
    ISecurableObject.RemoveRoleDefinitionBatch(Int32, IRoleDefinition)
    ISecurableObject.RemoveRoleDefinitionBatchAsync(Int32, IRoleDefinition)
    ISecurableObject.RemoveRoleDefinitionBatch(Batch, Int32, IRoleDefinition)
    ISecurableObject.RemoveRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition)
    Namespace: PnP.Core.Model.SharePoint
    Assembly: PnP.Core.dll
    Syntax
    public interface IList : IDataModel<IList>, IDataModelParent, IDataModelWithContext, ISupportModules<IList>, IDataModelGet<IList>, IDataModelLoad<IList>, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, ISecurableObject, IQueryableDataModel

    Properties

    All

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

    Declaration
    object All { get; }
    Property Value
    Object

    ContentTypes

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

    Declaration
    IContentTypeCollection ContentTypes { get; }
    Property Value
    IContentTypeCollection

    ContentTypesEnabled

    Gets or sets whether content types are enabled

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

    Created

    Specifies the date and time that the list was created.

    Declaration
    DateTime Created { get; }
    Property Value
    DateTime

    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

    DefaultViewUrl

    The url to the default view of this list.

    Declaration
    string DefaultViewUrl { get; }
    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

    EventReceivers

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

    Declaration
    IEventReceiverDefinitionCollection EventReceivers { get; }
    Property Value
    IEventReceiverDefinitionCollection

    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 Implements .
    See Requesting model collections and IQueryable performance considerations to learn more.

    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

    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

    IsCatalog

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

    Declaration
    bool IsCatalog { get; }
    Property Value
    Boolean

    IsDefaultDocumentLibrary

    Is this library the default document library of this site

    Declaration
    bool IsDefaultDocumentLibrary { get; }
    Property Value
    Boolean

    IsPrivate

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

    Declaration
    bool IsPrivate { get; }
    Property Value
    Boolean

    IsSiteAssetsLibrary

    Is this library the site's site asset library

    Declaration
    bool IsSiteAssetsLibrary { get; }
    Property Value
    Boolean

    IsSystemList

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

    Declaration
    bool IsSystemList { get; }
    Property Value
    Boolean

    ItemCount

    Number of items in the library

    Declaration
    int ItemCount { get; }
    Property Value
    Int32

    Items

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

    Declaration
    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.

    Declaration
    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.

    Declaration
    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.

    Declaration
    DateTime LastItemUserModifiedDate { get; }
    Property Value
    DateTime

    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

    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

    UserCustomActions

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

    Declaration
    IUserCustomActionCollection UserCustomActions { get; }
    Property Value
    IUserCustomActionCollection

    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 Implements .
    See Requesting model collections and IQueryable performance considerations to learn more.

    Declaration
    IViewCollection Views { get; }
    Property Value
    IViewCollection

    Webhooks

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

    Declaration
    IListSubscriptionCollection Webhooks { get; }
    Property Value
    IListSubscriptionCollection

    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>

    AddListFolderBatch(Batch, String, String, String)

    Adds a folder

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

    Batch to add this request to

    String path

    String parentFolder

    String contentTypeId

    Returns
    IListItem

    AddListFolderBatch(String, String, String)

    Adds a folder

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

    String parentFolder

    String contentTypeId

    Returns
    IListItem

    AddListFolderBatchAsync(Batch, String, String, String)

    Adds a folder

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

    Batch to add this request to

    String path

    String parentFolder

    String contentTypeId

    Returns
    Task<IListItem>

    AddListFolderBatchAsync(String, String, String)

    Adds a folder

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

    String parentFolder

    String contentTypeId

    Returns
    Task<IListItem>

    CheckIfUserHasPermissions(String, PermissionKind)

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

    Declaration
    bool CheckIfUserHasPermissions(string userPrincipalName, PermissionKind permissionKind)
    Parameters
    String userPrincipalName

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

    PermissionKind permissionKind

    Permission kind to check

    Returns
    Boolean

    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

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

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

    PermissionKind permissionKind

    Permission kind to check

    Returns
    Task<Boolean>

    Boolean that says if the user has permissions or not

    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

    ClassifyAndExtractOffPeak()

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

    Declaration
    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

    Declaration
    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

    Declaration
    void ClearDefaultColumnValues()

    ClearDefaultColumnValuesAsync()

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

    Declaration
    Task ClearDefaultColumnValuesAsync()
    Returns
    Task

    EnableAudienceTargeting()

    Enable audience targeting for a list

    Declaration
    void EnableAudienceTargeting()

    EnableAudienceTargetingAsync()

    Enable audience targeting for a list

    Declaration
    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

    Declaration
    List<IFile> FindFiles(string match)
    Parameters
    String match

    Returns
    PnP.Core.Model.SharePoint.List<IFile>

    A 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

    Declaration
    Task<List<IFile>> FindFilesAsync(string match)
    Parameters
    String match

    Returns
    Task<PnP.Core.Model.SharePoint.List<IFile>>

    A of found files as type IFile

    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>

    GetComplianceTagBatch()

    Retrieves the compliance tag / retention label for this list

    Declaration
    IBatchSingleResult<IComplianceTag> GetComplianceTagBatch()
    Returns
    IBatchSingleResult<IComplianceTag>

    GetComplianceTagBatch(Batch)

    Retrieves the compliance tag / retention label for this list

    Declaration
    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

    Declaration
    Task<IBatchSingleResult<IComplianceTag>> GetComplianceTagBatchAsync()
    Returns
    Task<IBatchSingleResult<IComplianceTag>>

    GetComplianceTagBatchAsync(Batch)

    Retrieves the compliance tag / retention label for this list

    Declaration
    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

    Declaration
    List<string> GetContentTypeOrder()
    Returns
    PnP.Core.Model.SharePoint.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

    Declaration
    Task<List<string>> GetContentTypeOrderAsync()
    Returns
    Task<PnP.Core.Model.SharePoint.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

    Declaration
    List<DefaultColumnValueOptions> GetDefaultColumnValues()
    Returns
    PnP.Core.Model.SharePoint.List<DefaultColumnValueOptions>

    List of default column values

    GetDefaultColumnValuesAsync()

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

    Declaration
    Task<List<DefaultColumnValueOptions>> GetDefaultColumnValuesAsync()
    Returns
    Task<PnP.Core.Model.SharePoint.List<DefaultColumnValueOptions>>

    List of default column values

    GetFlowInstances()

    Returns a list of flow instances connected to this list

    Declaration
    List<IFlowInstance> GetFlowInstances()
    Returns
    PnP.Core.Model.SharePoint.List<IFlowInstance>

    List of connected flow instances

    GetFlowInstancesAsync()

    Returns a list of flow instances connected to this list

    Declaration
    Task<List<IFlowInstance>> GetFlowInstancesAsync()
    Returns
    Task<PnP.Core.Model.SharePoint.List<IFlowInstance>>

    List of connected flow instances

    GetFlowInstancesBatch()

    Returns a list of flow instances connected to this list

    Declaration
    IEnumerableBatchResult<IFlowInstance> GetFlowInstancesBatch()
    Returns
    IEnumerableBatchResult<IFlowInstance>

    List of connected flow instances

    GetFlowInstancesBatch(Batch)

    Returns a list of flow instances connected to this list

    Declaration
    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

    Declaration
    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

    Declaration
    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

    Declaration
    IBasePermissions GetUserEffectivePermissions(string userPrincipalName)
    Parameters
    String userPrincipalName

    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

    Declaration
    Task<IBasePermissions> GetUserEffectivePermissionsAsync(string userPrincipalName)
    Parameters
    String userPrincipalName

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

    LoadListDataAsStreamBatch(RenderListDataOptions)

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

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

    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

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

    Batch to add this request to

    RenderListDataOptions renderOptions

    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

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

    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

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

    Batch to add this request to

    RenderListDataOptions renderOptions

    RenderListDataOptions defining the query to execute

    Returns
    Task<IBatchSingleResult<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

    ReIndex()

    Reindexes this list

    Declaration
    void ReIndex()

    ReIndexAsync()

    Reindexes this list

    Declaration
    Task ReIndexAsync()
    Returns
    Task

    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

    Declaration
    void ReorderContentTypes(List<string> contentTypeIdList)
    Parameters
    PnP.Core.Model.SharePoint.List<String> contentTypeIdList

    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

    Declaration
    Task ReorderContentTypesAsync(List<string> contentTypeIdList)
    Parameters
    PnP.Core.Model.SharePoint.List<String> contentTypeIdList

    Ordered list of content type ids to set

    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

    SetDefaultColumnValues(List<DefaultColumnValueOptions>)

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

    Declaration
    void SetDefaultColumnValues(List<DefaultColumnValueOptions> defaultColumnValues)
    Parameters
    PnP.Core.Model.SharePoint.List<DefaultColumnValueOptions> defaultColumnValues

    List with default column values to set

    SetDefaultColumnValuesAsync(List<DefaultColumnValueOptions>)

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

    Declaration
    Task SetDefaultColumnValuesAsync(List<DefaultColumnValueOptions> defaultColumnValues)
    Parameters
    PnP.Core.Model.SharePoint.List<DefaultColumnValueOptions> defaultColumnValues

    List with default column values to set

    Returns
    Task

    Extension Methods

    DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.Get<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.Load<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.QueryProperties<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<String, String>, Action<Dictionary<String, String>>)
    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer