Interface IFileCollection

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Public interface to define a collection of File objects

public interface IFileCollection : IQueryable<IFile>, IQueryable, IAsyncEnumerable<IFile>, IDataModelCollection<IFile>, IEnumerable<IFile>, IEnumerable, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad<IFile>, IDataModelCollectionDeleteByGuidId, ISupportModules<IFileCollection>

Inherited Members

IQueryable.ElementType

IQueryable.Expression

IQueryable.Provider

IAsyncEnumerable<IFile>.GetAsyncEnumerator(CancellationToken)

IEnumerable<IFile>.GetEnumerator()

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IRequestableCollection.Requested

IRequestableCollection.Length

IRequestableCollection.RequestedItems

IRequestableCollection.Clear()

IDataModelCollectionLoad<IFile>.LoadAsync(params Expression<Func<IFile, object>>[])

IDataModelCollectionLoad<IFile>.LoadBatchAsync(Batch, params Expression<Func<IFile, object>>[])

IDataModelCollectionDeleteByGuidId.DeleteById(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdAsync(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Batch, Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Batch, Guid)

Extension Methods

DataModelCollectionLoadExtensions.LoadBatchAsync<TModel>(IDataModelCollectionLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelCollectionLoadExtensions.LoadBatchAsync<TModel>(IDataModelCollectionLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelCollectionLoadExtensions.LoadBatch<TModel>(IDataModelCollectionLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelCollectionLoadExtensions.LoadBatch<TModel>(IDataModelCollectionLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelCollectionLoadExtensions.Load<TModel>(IDataModelCollectionLoad<TModel>, params Expression<Func<TModel, object>>[])

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)

Methods

Add(string, Stream, bool)

Add a file to the file collection using batching (sync)

IFile Add(string name, Stream content, bool overwrite = false)

Parameters

name string

The name of the file.

content Stream

The content of the file.

overwrite bool

Indicates whether the file should be overwritten if already existing.

Returns

IFile

The added file object.

AddAsync(string, Stream, bool)

Add a file to the file collection using batching (async)

Task<IFile> AddAsync(string name, Stream content, bool overwrite = false)

Parameters

name string

The name of the file.

content Stream

The content of the file.

overwrite bool

Indicates whether the file should be overwritten if already existing.

Returns

Task<IFile>

The added file object.

AddTemplateFile(string, TemplateFileType)

Adds a file based upon an out of the box template

IFile AddTemplateFile(string serverRelativePageName, TemplateFileType templateFileType)

Parameters

serverRelativePageName string

Server relative url of the page to add

templateFileType TemplateFileType

Type of template file to add

Returns

IFile

The added IFile

AddTemplateFileAsync(string, TemplateFileType)

Adds a file based upon an out of the box template

Task<IFile> AddTemplateFileAsync(string serverRelativePageName, TemplateFileType templateFileType)

Parameters

serverRelativePageName string

Server relative url of the page to add

templateFileType TemplateFileType

Type of template file to add

Returns

Task<IFile>

The added IFile