Interface ICommentCollection

Public interface to define a collection of comment objects.

Inherited Members

IQueryable.ElementType

IQueryable.Expression

IQueryable.Provider

IEnumerable<IComment>.GetEnumerator()

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IRequestableCollection.Requested

IRequestableCollection.Length

IRequestableCollection.RequestedItems

IRequestableCollection.Clear()

Namespace: PnP.Core.Model.SharePoint

Assembly: PnP.Core.dll

Syntax

public interface ICommentCollection : IQueryable<IComment>, IQueryable, IDataModelCollection<IComment>, IEnumerable<IComment>, IEnumerable, IDataModelParent, IDataModelWithContext, IRequestableCollection, ISupportModules<ICommentCollection>

Methods

Add(string)

Adds a comment to a list item.

Declaration

IComment Add(string text)

Parameters

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

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

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

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

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

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

string userName Name of the user to show in front of the @ (e.g. @Bert)

string userPrincipalName The UPN of the user represented in the at mentioning

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

Returns

string The formatted at mentioning html

Extension Methods

QueryableExtensions.AsRequested<TSource>(IDataModelCollection<TSource>)

RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<string, string>, Action<Dictionary<string, string>>)

RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<string, string>>)

QueryableExtensions.AsAsyncEnumerable<TSource>(IQueryable<TSource>)

QueryableExtensions.AsBatchAsync<TSource>(IQueryable<TSource>)

QueryableExtensions.AsBatchAsync<TSource>(IQueryable<TSource>, Batch)

QueryableExtensions.AsBatch<TSource>(IQueryable<TSource>)

QueryableExtensions.AsBatch<TSource>(IQueryable<TSource>, Batch)

QueryableExtensions.FirstAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource, bool>>, CancellationToken)

QueryableExtensions.FirstAsync<TSource>(IQueryable<TSource>, CancellationToken)

QueryableExtensions.FirstOrDefaultAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource, bool>>, CancellationToken)

QueryableExtensions.FirstOrDefaultAsync<TSource>(IQueryable<TSource>, CancellationToken)

QueryableExtensions.ForEachAsync<T>(IQueryable<T>, Action<T>, CancellationToken)

QueryableExtensions.QueryProperties<TResult>(IQueryable<TResult>, params Expression<Func<TResult, object>>[])

QueryableExtensions.ToArrayAsync<TSource>(IQueryable<TSource>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey>(IQueryable<TSource>, Func<TSource, TKey>, IEqualityComparer<TKey>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey>(IQueryable<TSource>, Func<TSource, TKey>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey, TElement>(IQueryable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>, IEqualityComparer<TKey>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey, TElement>(IQueryable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>, CancellationToken)

QueryableExtensions.ToListAsync<TSource>(IQueryable<TSource>, CancellationToken)