Interface IFileVersion

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Public interface to define a FileVersion object

public interface IFileVersion : IDataModel<IFileVersion>, IDataModelParent, IDataModelWithContext, ISupportModules<IFileVersion>, IDataModelGet<IFileVersion>, IDataModelLoad<IFileVersion>, IQueryableDataModel

Inherited Members

IDataModel<IFileVersion>.Requested

IDataModel<IFileVersion>.HasValue(string)

IDataModel<IFileVersion>.HasChanged(string)

IDataModel<IFileVersion>.IsPropertyAvailable(Expression<Func<IFileVersion, object>>)

IDataModel<IFileVersion>.ArePropertiesAvailable(params Expression<Func<IFileVersion, object>>[])

IDataModel<IFileVersion>.EnsureProperties(params Expression<Func<IFileVersion, object>>[])

IDataModel<IFileVersion>.EnsurePropertiesAsync(params Expression<Func<IFileVersion, object>>[])

IDataModel<IFileVersion>.ExecuteRequestAsync(ApiRequest)

IDataModel<IFileVersion>.ExecuteRequest(ApiRequest)

IDataModel<IFileVersion>.ExecuteRequestBatchAsync(ApiRequest)

IDataModel<IFileVersion>.ExecuteRequestBatch(ApiRequest)

IDataModel<IFileVersion>.ExecuteRequestBatchAsync(Batch, ApiRequest)

IDataModel<IFileVersion>.ExecuteRequestBatch(Batch, ApiRequest)

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IDataModelGet<IFileVersion>.GetBatchAsync(Batch, params Expression<Func<IFileVersion, object>>[])

IDataModelGet<IFileVersion>.GetAsync(params Expression<Func<IFileVersion, object>>[])

IDataModelLoad<IFileVersion>.LoadBatchAsync(Batch, params Expression<Func<IFileVersion, object>>[])

IDataModelLoad<IFileVersion>.LoadAsync(params Expression<Func<IFileVersion, object>>[])

Extension Methods

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.Get<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.Load<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.QueryProperties<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

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

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

Properties

All

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

object All { get; }

Property Value

object

CheckInComment

Gets a value that specifies the check-in comment.

string CheckInComment { get; }

Property Value

string

Created

Gets a value that specifies the creation date and time for the file version.

DateTime Created { get; }

Property Value

DateTime

CreatedBy

The ISharePointUser that created this version

ISharePointUser CreatedBy { get; }

Property Value

ISharePointUser

Id

Gets the internal identifier for the file version.

int Id { get; }

Property Value

int

IsCurrentVersion

Gets a value that specifies whether the file version is the current version.

bool IsCurrentVersion { get; }

Property Value

bool

Size

Gets the size of this version of the file.

long Size { get; }

Property Value

long

Url

Gets a value that specifies the relative URL of the file version based on the URL for the site or subsite.

string Url { get; }

Property Value

string

VersionLabel

Gets a value that specifies the implementation specific identifier of the file.

string VersionLabel { get; }

Property Value

string

Methods

GetContent(bool)

Get the content of this file version.

Stream GetContent(bool streamContent = false)

Parameters

streamContent bool

Already return the content before all bytes are read, needed for large file downloads

Returns

Stream

Stream containing the binary content of the file

GetContentAsync(bool)

Get the content of this file version.

Task<Stream> GetContentAsync(bool streamContent = false)

Parameters

streamContent bool

Already return the content before all bytes are read, needed for large file downloads

Returns

Task<Stream>

Stream containing the binary content of the file

GetContentBytes()

Get the content of the file version.

byte[] GetContentBytes()

Returns

byte[]

The binary content of the file

GetContentBytesAsync()

Get the content of this file version.

Task<byte[]> GetContentBytesAsync()

Returns

Task<byte[]>

The binary content of the file