Interface IListItem

Public interface to define a SharePoint Online list item

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

Properties

All

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

Declaration
object All { get; }
Property Value
Object

AttachmentFiles

Collection of attachments for this list item

Declaration
IAttachmentCollection AttachmentFiles { get; }
Property Value
IAttachmentCollection

CommentsDisabled

Determines if comments are disabled for the list item

Declaration
bool CommentsDisabled { get; }
Property Value
Boolean

CommentsDisabledScope

The scope for which comments are disabled

Declaration
CommentsDisabledScope CommentsDisabledScope { get; }
Property Value
CommentsDisabledScope

ContentType

The content type for the list item

Declaration
IContentType ContentType { get; }
Property Value
IContentType

FieldValuesAsHtml

All the field values for the list item as HTML

Declaration
IFieldStringValues FieldValuesAsHtml { get; }
Property Value
IFieldStringValues

FieldValuesAsText

All the field values for the list item as text

Declaration
IFieldStringValues FieldValuesAsText { get; }
Property Value
IFieldStringValues

FieldValuesForEdit

All the field values for the list item for editing

Declaration
IFieldStringValues FieldValuesForEdit { get; }
Property Value
IFieldStringValues

File

The file, if any, associated with the list item

Declaration
IFile File { get; }
Property Value
IFile

FileSystemObjectType

The FileSystemObjectType for the list item, such as Folder or File

Declaration
FileSystemObjectType FileSystemObjectType { get; }
Property Value
FileSystemObjectType

Folder

The folder, if any, represented by the list item

Declaration
IFolder Folder { get; }
Property Value
IFolder

Id

Id of the list item

Declaration
int Id { get; }
Property Value
Int32

LikedByInformation

Information about the likes on this list item

Declaration
ILikedByInformation LikedByInformation { get; }
Property Value
ILikedByInformation

ParentList

The list for the list item

Declaration
IList ParentList { get; }
Property Value
IList

Properties

The properties of the list item

Declaration
IPropertyValues Properties { get; }
Property Value
IPropertyValues

RoleAssignments

Role assignments of the list item

Declaration
IRoleAssignmentCollection RoleAssignments { get; }
Property Value
IRoleAssignmentCollection

ServerRedirectedEmbedUri

The URI used to render the WOPI (Web Application Open Platform Interface) frame

Declaration
string ServerRedirectedEmbedUri { get; }
Property Value
String

ServerRedirectedEmbedUrl

The URL used to render the WOPI (Web Application Open Platform Interface) frame

Declaration
string ServerRedirectedEmbedUrl { get; }
Property Value
String

Title

Title value of the list item

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

UniqueId

The unique identifier of the list item

Declaration
Guid UniqueId { get; }
Property Value
Guid

Versions

Gets a value that returns a collection of list item version objects that represent the versions of the list item

Declaration
IListItemVersionCollection Versions { get; }
Property Value
IListItemVersionCollection

Methods

AddRoleDefinition(Int32, IRoleDefinition)

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

Declaration
void AddRoleDefinition(int principalId, IRoleDefinition roleDefinition)
Parameters
Int32 principalId

IRoleDefinition roleDefinition

Role definition to add

AddRoleDefinitionAsync(Int32, IRoleDefinition)

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

Declaration
Task AddRoleDefinitionAsync(int principalId, IRoleDefinition roleDefinition)
Parameters
Int32 principalId

IRoleDefinition roleDefinition

Role definition to add
Returns
Task

AddRoleDefinitionBatch(Batch, Int32, IRoleDefinition)

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

Declaration
void AddRoleDefinitionBatch(Batch batch, int principalId, IRoleDefinition roleDefinition)
Parameters
Batch batch

The batch to add this request to
Int32 principalId

IRoleDefinition roleDefinition

Role definition to add

AddRoleDefinitionBatch(Int32, IRoleDefinition)

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

Declaration
void AddRoleDefinitionBatch(int principalId, IRoleDefinition roleDefinition)
Parameters
Int32 principalId

IRoleDefinition roleDefinition

Role definition to add

AddRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition)

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

Declaration
Task AddRoleDefinitionBatchAsync(Batch batch, int principalId, IRoleDefinition roleDefinition)
Parameters
Batch batch

The batch to add this request to
Int32 principalId

IRoleDefinition roleDefinition

Role definition to add
Returns
Task

AddRoleDefinitionBatchAsync(Int32, IRoleDefinition)

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

Declaration
Task AddRoleDefinitionBatchAsync(int principalId, IRoleDefinition roleDefinition)
Parameters
Int32 principalId

IRoleDefinition roleDefinition

Role definition to add
Returns
Task

AddRoleDefinitions(Int32, String[])

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

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

String[] names

Returns
Boolean

AddRoleDefinitionsAsync(Int32, String[])

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

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

String[] names

Returns
Task<Boolean>

AreCommentsDisabled()

Are comments disabled for this IListItem?

Declaration
bool AreCommentsDisabled()
Returns
Boolean

True if disabled, false otherwise

AreCommentsDisabledAsync()

Are comments disabled for this IListItem?

Declaration
Task<bool> AreCommentsDisabledAsync()
Returns
Task<Boolean>

True if disabled, false otherwise

BreakRoleInheritance(Boolean, Boolean)

Break role inheritance on the current item

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

Boolean clearSubscopes

BreakRoleInheritanceAsync(Boolean, Boolean)

Break role inheritance on the current item

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

Boolean clearSubscopes

Returns
Task

BreakRoleInheritanceBatch(Batch, Boolean, Boolean)

Break role inheritance on the current item

Declaration
void BreakRoleInheritanceBatch(Batch batch, bool copyRoleAssignments, bool clearSubscopes)
Parameters
Batch batch

The batch to add this request to
Boolean copyRoleAssignments

Boolean clearSubscopes

BreakRoleInheritanceBatch(Boolean, Boolean)

Break role inheritance on the current item

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

Boolean clearSubscopes

BreakRoleInheritanceBatchAsync(Batch, Boolean, Boolean)

Break role inheritance on the current item

Declaration
Task BreakRoleInheritanceBatchAsync(Batch batch, bool copyRoleAssignments, bool clearSubscopes)
Parameters
Batch batch

The batch to add this request to
Boolean copyRoleAssignments

Boolean clearSubscopes

Returns
Task

BreakRoleInheritanceBatchAsync(Boolean, Boolean)

Break role inheritance on the current item

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

Boolean clearSubscopes

Returns
Task

GetComments(Expression<Func<IComment, Object>>[])

Get list item comments

Declaration
ICommentCollection GetComments(params Expression<Func<IComment, object>>[] selectors)
Parameters
Expression<Func<IComment, Object>>[] selectors

The expressions declaring the fields to select
Returns
ICommentCollection

GetCommentsAsync(Expression<Func<IComment, Object>>[])

Get list item comments

Declaration
Task<ICommentCollection> GetCommentsAsync(params Expression<Func<IComment, object>>[] selectors)
Parameters
Expression<Func<IComment, Object>>[] selectors

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

GetDisplayName()

Gets the display name of the list item.

Declaration
string GetDisplayName()
Returns
String

The display name or null.

GetDisplayNameAsync()

Gets the display name of the list item.

Declaration
Task<string> GetDisplayNameAsync()
Returns
Task<String>

The display name or null.

GetParentFolder()

Returns the IFolder that holds this item

Declaration
IFolder GetParentFolder()
Returns
IFolder

The IFolder for this item is returned, if the item itself is a folder then the item is returned as IFolder.

GetParentFolderAsync()

Returns the IFolder that holds this item

Declaration
Task<IFolder> GetParentFolderAsync()
Returns
Task<IFolder>

The IFolder for this item is returned, if the item itself is a folder then the item is returned as IFolder.

GetRoleDefinitions(Int32)

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

Declaration
IRoleDefinitionCollection GetRoleDefinitions(int principalId)
Parameters
Int32 principalId

Returns
IRoleDefinitionCollection

GetRoleDefinitionsAsync(Int32)

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

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

Returns
Task<IRoleDefinitionCollection>

IsFile()

Checks if this IListItem is a file

Declaration
bool IsFile()
Returns
Boolean

Returns true if this IListItem is a file.

IsFileAsync()

Checks if this IListItem is a file

Declaration
Task<bool> IsFileAsync()
Returns
Task<Boolean>

Returns true if this IListItem is a file.

IsFolder()

Checks if this IListItem is a folder

Declaration
bool IsFolder()
Returns
Boolean

Returns true if this IListItem is a folder.

IsFolderAsync()

Checks if this IListItem is a folder

Declaration
Task<bool> IsFolderAsync()
Returns
Task<Boolean>

Returns true if this IListItem is a folder.

NewFieldLookupValue(IField, Int32)

Creates a new IFieldLookupValue object

Declaration
IFieldLookupValue NewFieldLookupValue(IField fieldToUpdate, int lookupId)
Parameters
IField fieldToUpdate

IField representing the field to set
Int32 lookupId

Id of the lookup value
Returns
IFieldLookupValue

Configured IFieldLookupValue object

NewFieldTaxonomyValue(IField, Guid, String, Int32)

Creates a new IFieldTaxonomyValue object

Declaration
IFieldTaxonomyValue NewFieldTaxonomyValue(IField fieldToUpdate, Guid termId, string label, int wssId = null)
Parameters
IField fieldToUpdate

IField representing the field to set
Guid termId

Name of the term to set
String label

Label of the term to set
Int32 wssId

Optionally provide the wssId value
Returns
IFieldTaxonomyValue

Configured IFieldTaxonomyValue object

NewFieldUrlValue(IField, String, String)

Creates a new IFieldUrlValue object

Declaration
IFieldUrlValue NewFieldUrlValue(IField fieldToUpdate, string url, string description = null)
Parameters
IField fieldToUpdate

IField representing the field to set
String url

Url value
String description

Optional description value
Returns
IFieldUrlValue

Configured IFieldUrlValue object

NewFieldUserValue(IField, ISharePointPrincipal)

Creates a new IFieldUserValue object

Declaration
IFieldUserValue NewFieldUserValue(IField fieldToUpdate, ISharePointPrincipal principal)
Parameters
IField fieldToUpdate

IField representing the field to set
ISharePointPrincipal principal

ISharePointUser or ISharePointGroup
Returns
IFieldUserValue

Configured IFieldUserValue object

NewFieldUserValue(IField, Int32)

Creates a new IFieldUserValue object

Declaration
IFieldUserValue NewFieldUserValue(IField fieldToUpdate, int userId)
Parameters
IField fieldToUpdate

IField representing the field to set
Int32 userId

Id of the user
Returns
IFieldUserValue

Configured IFieldUserValue object

NewFieldValueCollection(IField)

Creates a new collection to hold IFieldValue objects

Declaration
IFieldValueCollection NewFieldValueCollection(IField fieldToUpdate)
Parameters
IField fieldToUpdate

IField representing the field to set
Returns
IFieldValueCollection

Recycle()

Recycle the current item

Declaration
Guid Recycle()
Returns
Guid

RecycleAsync()

Recycle the current item

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

RecycleBatch()

Recycle the current item

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

RecycleBatch(Batch)

Recycle the current item

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

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

RecycleBatchAsync()

Recycle the current item

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

RecycleBatchAsync(Batch)

Recycle the current item

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

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

RemoveRoleDefinition(Int32, IRoleDefinition)

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

Declaration
void RemoveRoleDefinition(int principalId, IRoleDefinition roleDefinition)
Parameters
Int32 principalId

IRoleDefinition roleDefinition

Role definition to remove

RemoveRoleDefinitionAsync(Int32, IRoleDefinition)

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

Declaration
Task RemoveRoleDefinitionAsync(int principalId, IRoleDefinition roleDefinition)
Parameters
Int32 principalId

IRoleDefinition roleDefinition

Role definition to remove
Returns
Task

RemoveRoleDefinitionBatch(Batch, Int32, IRoleDefinition)

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

Declaration
void RemoveRoleDefinitionBatch(Batch batch, int principalId, IRoleDefinition roleDefinition)
Parameters
Batch batch

The batch to add this request to
Int32 principalId

IRoleDefinition roleDefinition

Role definition to remove

RemoveRoleDefinitionBatch(Int32, IRoleDefinition)

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

Declaration
void RemoveRoleDefinitionBatch(int principalId, IRoleDefinition roleDefinition)
Parameters
Int32 principalId

IRoleDefinition roleDefinition

Role definition to remove

RemoveRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition)

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

Declaration
Task RemoveRoleDefinitionBatchAsync(Batch batch, int principalId, IRoleDefinition roleDefinition)
Parameters
Batch batch

The batch to add this request to
Int32 principalId

IRoleDefinition roleDefinition

Role definition to remove
Returns
Task

RemoveRoleDefinitionBatchAsync(Int32, IRoleDefinition)

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

Declaration
Task RemoveRoleDefinitionBatchAsync(int principalId, IRoleDefinition roleDefinition)
Parameters
Int32 principalId

IRoleDefinition roleDefinition

Role definition to remove
Returns
Task

RemoveRoleDefinitions(Int32, String[])

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

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

String[] names

Returns
Boolean

RemoveRoleDefinitionsAsync(Int32, String[])

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

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

String[] names

Returns
Task<Boolean>

ResetRoleInheritance()

Reset role inheritance on the current item

Declaration
void ResetRoleInheritance()

ResetRoleInheritanceAsync()

Reset role inheritance on the current item

Declaration
Task ResetRoleInheritanceAsync()
Returns
Task

ResetRoleInheritanceBatch()

Reset role inheritance on the current item

Declaration
void ResetRoleInheritanceBatch()

ResetRoleInheritanceBatch(Batch)

Reset role inheritance on the current item

Declaration
void ResetRoleInheritanceBatch(Batch batch)
Parameters
Batch batch

The batch to add this request to

ResetRoleInheritanceBatchAsync()

Reset role inheritance on the current item

Declaration
Task ResetRoleInheritanceBatchAsync()
Returns
Task

ResetRoleInheritanceBatchAsync(Batch)

Reset role inheritance on the current item

Declaration
Task ResetRoleInheritanceBatchAsync(Batch batch)
Parameters
Batch batch

The batch to add this request to
Returns
Task

SetCommentsDisabled(Boolean)

Enable/Disable comments for this list item

Declaration
void SetCommentsDisabled(bool commentsDisabled)
Parameters
Boolean commentsDisabled

Do comments need to enabled or disabled

SetCommentsDisabledAsync(Boolean)

Enable/Disable comments for this list item

Declaration
Task SetCommentsDisabledAsync(bool commentsDisabled)
Parameters
Boolean commentsDisabled

Do comments need to enabled or disabled
Returns
Task

SetComplianceTag(String, Boolean, Boolean, Boolean, Boolean)

Sets a compliancetag / retention label for this list item

Declaration
void SetComplianceTag(string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock)
Parameters
String complianceTag

The tag/label to set for this list item
Boolean isTagPolicyHold

Whether the tag is hold
Boolean isTagPolicyRecord

Whether the tag is record
Boolean isEventBasedTag

Whether the tag is Event based, this is not used
Boolean isTagSuperLock

Whether the tag is Sec 17 tag,no allow change even for site admin

SetComplianceTagAsync(String, Boolean, Boolean, Boolean, Boolean)

Sets a compliancetag / retention label for this list item

Declaration
Task SetComplianceTagAsync(string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock)
Parameters
String complianceTag

The tag/label to set for this list item
Boolean isTagPolicyHold

Whether the tag is hold
Boolean isTagPolicyRecord

Whether the tag is record
Boolean isEventBasedTag

Whether the tag is Event based, this is not used
Boolean isTagSuperLock

Whether the tag is Sec 17 tag,no allow change even for site admin
Returns
Task

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

Sets a compliancetag / retention label for this list item

Declaration
void SetComplianceTagBatch(Batch batch, string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock)
Parameters
Batch batch

Batch to add the request to
String complianceTag

The tag/label to set for this list item
Boolean isTagPolicyHold

Whether the tag is hold
Boolean isTagPolicyRecord

Whether the tag is record
Boolean isEventBasedTag

Whether the tag is Event based, this is not used
Boolean isTagSuperLock

Whether the tag is Sec 17 tag,no allow change even for site admin

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

Sets a compliancetag / retention label for this list item

Declaration
void SetComplianceTagBatch(string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock)
Parameters
String complianceTag

The tag/label to set for this list item
Boolean isTagPolicyHold

Whether the tag is hold
Boolean isTagPolicyRecord

Whether the tag is record
Boolean isEventBasedTag

Whether the tag is Event based, this is not used
Boolean isTagSuperLock

Whether the tag is Sec 17 tag,no allow change even for site admin

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

Sets a compliancetag / retention label for this list item

Declaration
Task SetComplianceTagBatchAsync(Batch batch, string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock)
Parameters
Batch batch

Batch to add the request to
String complianceTag

The tag/label to set for this list item
Boolean isTagPolicyHold

Whether the tag is hold
Boolean isTagPolicyRecord

Whether the tag is record
Boolean isEventBasedTag

Whether the tag is Event based, this is not used
Boolean isTagSuperLock

Whether the tag is Sec 17 tag,no allow change even for site admin
Returns
Task

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

Sets a compliancetag / retention label for this list item

Declaration
Task SetComplianceTagBatchAsync(string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock)
Parameters
String complianceTag

The tag/label to set for this list item
Boolean isTagPolicyHold

Whether the tag is hold
Boolean isTagPolicyRecord

Whether the tag is record
Boolean isEventBasedTag

Whether the tag is Event based, this is not used
Boolean isTagSuperLock

Whether the tag is Sec 17 tag,no allow change even for site admin
Returns
Task

SystemUpdate()

Performs a system update of the list item

Declaration
void SystemUpdate()

SystemUpdateAsync()

Performs a system update of the list item

Declaration
Task SystemUpdateAsync()
Returns
Task

SystemUpdateBatch()

Performs a system update of the list item

Declaration
void SystemUpdateBatch()

SystemUpdateBatch(Batch)

Performs a system update of the list item

Declaration
void SystemUpdateBatch(Batch batch)
Parameters
Batch batch

Batch to add the systemupdate request to

SystemUpdateBatchAsync()

Performs a system update of the list item

Declaration
Task SystemUpdateBatchAsync()
Returns
Task

SystemUpdateBatchAsync(Batch)

Performs a system update of the list item

Declaration
Task SystemUpdateBatchAsync(Batch batch)
Parameters
Batch batch

Batch to add the systemupdate request to
Returns
Task

UpdateOverwriteVersion()

Performs a UpdateOverwriteVersion of the list item

Declaration
void UpdateOverwriteVersion()

UpdateOverwriteVersionAsync()

Performs a UpdateOverwriteVersion of the list item

Declaration
Task UpdateOverwriteVersionAsync()
Returns
Task

UpdateOverwriteVersionBatch()

Performs a UpdateOverwriteVersion of the list item

Declaration
void UpdateOverwriteVersionBatch()

UpdateOverwriteVersionBatch(Batch)

Performs a UpdateOverwriteVersion of the list item

Declaration
void UpdateOverwriteVersionBatch(Batch batch)
Parameters
Batch batch

Batch to add the UpdateOverwriteVersion request to

UpdateOverwriteVersionBatchAsync()

Performs a UpdateOverwriteVersion of the list item

Declaration
Task UpdateOverwriteVersionBatchAsync()
Returns
Task

UpdateOverwriteVersionBatchAsync(Batch)

Performs a UpdateOverwriteVersion of the list item

Declaration
Task UpdateOverwriteVersionBatchAsync(Batch batch)
Parameters
Batch batch

Batch to add the UpdateOverwriteVersion request to
Returns
Task

Extension Methods