Interface ICommentCollection

Public interface to define a collection of comment objects.

Inherited Members
Namespace: PnP.Core.Model.SharePoint
Assembly: PnP.Core.dll
Syntax
public interface ICommentCollection : IDataModelCollection<IComment>, IDataModelParent, IDataModelWithContext, IRequestableCollection, ISupportModules<ICommentCollection>

Methods

Add(String)

Adds a comment to a list item.

Declaration
IComment Add(string text)
Parameters
System.String text

Comment to add
Returns
IComment

Newly added comment

AddAsync(String)

Adds a comment to a list item.

Declaration
Task<IComment> AddAsync(string text)
Parameters
System.String text

Comment to add
Returns
Task<IComment>

Newly added comment

AddBatch(Batch, String)

Adds a comment to a list item.

Declaration
IComment AddBatch(Batch batch, string text)
Parameters
Batch batch

Batch to use
System.String text

Comment to add
Returns
IComment

Newly added comment

AddBatch(String)

Adds a comment to a list item.

Declaration
IComment AddBatch(string text)
Parameters
System.String text

Comment to add
Returns
IComment

Newly added comment

AddBatchAsync(Batch, String)

Adds a comment to a list item.

Declaration
Task<IComment> AddBatchAsync(Batch batch, string text)
Parameters
Batch batch

Batch to use
System.String text

Comment to add
Returns
Task<IComment>

Newly added comment

AddBatchAsync(String)

Adds a comment to a list item.

Declaration
Task<IComment> AddBatchAsync(string text)
Parameters
System.String text

Comment to add
Returns
Task<IComment>

Newly added comment

DeleteAll()

Delete all comments in this collection.

Declaration
void DeleteAll()

DeleteAllAsync()

Delete all comments in this collection.

Declaration
Task DeleteAllAsync()
Returns
Task

GetAtMentioningString(String, String, String)

Constructs the at mentioning string to be used when at mentioning someone in a comment or reply

Declaration
string GetAtMentioningString(string userName, string userPrincipalName, string email = null)
Parameters
System.String userName

Name of the user to show in front of the @ (e.g. @Bert)
System.String userPrincipalName

The UPN of the user represented in the at mentioning
System.String email

The email of the user represented in the at mentioning. If not specified the UPN is used for email as well
Returns
System.String

The formatted at mentioning html

Extension Methods