Interface IFile

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Public interface to define a File object

public interface IFile : IDataModel<IFile>, IDataModelParent, IDataModelWithContext, ISupportModules<IFile>, IDataModelGet<IFile>, IDataModelLoad<IFile>, IDataModelUpdate, IDataModelDelete, IQueryableDataModel

Inherited Members

IDataModel<IFile>.Requested

IDataModel<IFile>.HasValue(string)

IDataModel<IFile>.HasChanged(string)

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

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

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

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

IDataModel<IFile>.ExecuteRequestAsync(ApiRequest)

IDataModel<IFile>.ExecuteRequest(ApiRequest)

IDataModel<IFile>.ExecuteRequestBatchAsync(ApiRequest)

IDataModel<IFile>.ExecuteRequestBatch(ApiRequest)

IDataModel<IFile>.ExecuteRequestBatchAsync(Batch, ApiRequest)

IDataModel<IFile>.ExecuteRequestBatch(Batch, ApiRequest)

IDataModelParent.Parent

IDataModelWithContext.PnPContext

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

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

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

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

IDataModelUpdate.UpdateBatchAsync()

IDataModelUpdate.UpdateBatchAsync(Batch)

IDataModelUpdate.UpdateAsync()

IDataModelUpdate.UpdateBatch()

IDataModelUpdate.UpdateBatch(Batch)

IDataModelUpdate.Update()

IDataModelDelete.DeleteBatchAsync()

IDataModelDelete.DeleteBatchAsync(Batch)

IDataModelDelete.DeleteAsync()

IDataModelDelete.DeleteBatch()

IDataModelDelete.DeleteBatch(Batch)

IDataModelDelete.Delete()

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

Author

Gets a value that specifies the user who added the file.

ISharePointUser Author { get; }

Property Value

ISharePointUser

CheckInComment

Returns the comment that was specified when the document was checked into the document library

string CheckInComment { get; }

Property Value

string

CheckOutType

Gets a value that specifies the type of check out associated with the file.

CheckOutType CheckOutType { get; }

Property Value

CheckOutType

CheckedOutByUser

Gets a value that returns the user who has checked out the file.

ISharePointUser CheckedOutByUser { get; }

Property Value

ISharePointUser

ContentTag

Returns internal version of content, used to validate document equality for read purposes.

string ContentTag { get; }

Property Value

string

CustomizedPageStatus

Gets a value that specifies the customization status of the file.

CustomizedPageStatus CustomizedPageStatus { get; }

Property Value

CustomizedPageStatus

ETag

Gets a value that specifies the ETag value.

string ETag { get; }

Property Value

string

EffectiveInformationRightsManagementSettings

Gets the Information Rights Management settings of the file.

IEffectiveInformationRightsManagementSettings EffectiveInformationRightsManagementSettings { get; }

Property Value

IEffectiveInformationRightsManagementSettings

HasAlternateContentStreams

Indicates whether this file has alternate streams with content.

bool HasAlternateContentStreams { get; }

Property Value

bool

InformationRightsManagementSettings

Gets the Information Rights Management settings of the file.

IInformationRightsManagementFileSettings InformationRightsManagementSettings { get; }

Property Value

IInformationRightsManagementFileSettings

IrmEnabled

Gets or sets whether Irm is enabled on the file.

bool IrmEnabled { get; set; }

Property Value

bool

Length

Gets the file size of the file.

long Length { get; }

Property Value

long

Level

Level of the file (published or draft)

PublishedStatus Level { get; }

Property Value

PublishedStatus

LinkingUri

Gets the linking URI of the file.

string LinkingUri { get; }

Property Value

string

LinkingUrl

Gets the linking URL of the file.

string LinkingUrl { get; }

Property Value

string

ListId

Gets the id of the list containing the file.

Guid ListId { get; }

Property Value

Guid

ListItemAllFields

Gets a value that specifies the list item field values for the list item corresponding to the file.

IListItem ListItemAllFields { get; }

Property Value

IListItem

LockedByUser

Gets a value that returns the user who has locked the file.

ISharePointUser LockedByUser { get; }

Property Value

ISharePointUser

MajorVersion

Gets a value that specifies the major version of the file.

int MajorVersion { get; }

Property Value

int

MinorVersion

Gets a value that specifies the minor version of the file.

int MinorVersion { get; }

Property Value

int

ModifiedBy

Gets a value that returns the last user who has modified the file.

ISharePointUser ModifiedBy { get; }

Property Value

ISharePointUser

Name

Gets the name of the file including the extension.

string Name { get; }

Property Value

string

PageRenderType

Gets the list page render type of the file.

ListPageRenderType PageRenderType { get; }

Property Value

ListPageRenderType

Properties

Gets the properties of the file.

IPropertyValues Properties { get; }

Property Value

IPropertyValues

ServerRedirectedUrl

Gets the URL which opens the document in Office Web Apps.

string ServerRedirectedUrl { get; }

Property Value

string

ServerRelativeUrl

Gets the relative URL of the file based on the URL for the server.

string ServerRelativeUrl { get; }

Property Value

string

SiteId

Gets the Id of the Site collection in which the file is stored.

Guid SiteId { get; }

Property Value

Guid

TimeCreated

Gets a value that specifies when the file was created.

DateTime TimeCreated { get; }

Property Value

DateTime

TimeLastModified

Gets a value that specifies when the file was last modified.

DateTime TimeLastModified { get; }

Property Value

DateTime

Title

Gets a value that specifies the display name of the file.

string Title { get; }

Property Value

string

UIVersion

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

int UIVersion { get; }

Property Value

int

UIVersionLabel

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

string UIVersionLabel { get; }

Property Value

string

UniqueId

Gets the unique Id of the file.

Guid UniqueId { get; }

Property Value

Guid

VersionEvents

Gets a value that returns a collection of file version event objects that represent the version events of the file.

IFileVersionEventCollection VersionEvents { get; }

Property Value

IFileVersionEventCollection

Versions

Gets a value that returns a collection of file version objects that represent the versions of the file. Implements IQueryable<T>.
See Requesting model collections and IQueryable performance considerations to learn more.

IFileVersionCollection Versions { get; }

Property Value

IFileVersionCollection

VroomDriveID

Get the Graph Drive ID of the drive to which the file belongs.

string VroomDriveID { get; }

Property Value

string

VroomItemID

Get the Graph DriveItem ID of the file.

string VroomItemID { get; }

Property Value

string

WebId

Gets the Id of the site in which the file is stored.

Guid WebId { get; }

Property Value

Guid

Methods

Approve(string)

Approves the file.

The approval comment

void Approve(string comment = null)

Parameters

comment string

ApproveAsync(string)

Approves the file.

The approval comment

Task ApproveAsync(string comment = null)

Parameters

comment string

Returns

Task

ApproveBatch(Batch, string)

Approves the file.

The approval comment The batch instance to use.

void ApproveBatch(Batch batch, string comment = null)

Parameters

batch Batch

comment string

ApproveBatch(string)

Approves the file.

The approval comment

void ApproveBatch(string comment = null)

Parameters

comment string

ApproveBatchAsync(Batch, string)

Approves the file.

The approval comment The batch instance to use.

Task ApproveBatchAsync(Batch batch, string comment = null)

Parameters

batch Batch

comment string

Returns

Task

ApproveBatchAsync(string)

Approves the file.

The approval comment

Task ApproveBatchAsync(string comment = null)

Parameters

comment string

Returns

Task

Checkin(string, CheckinType)

Checks in the file.

The check in comment. The type of check in to use.

void Checkin(string comment = null, CheckinType checkinType = CheckinType.MinorCheckIn)

Parameters

comment string

checkinType CheckinType

CheckinAsync(string, CheckinType)

Checks in the file.

The check in comment. The type of check in to use.

Task CheckinAsync(string comment = null, CheckinType checkinType = CheckinType.MinorCheckIn)

Parameters

comment string

checkinType CheckinType

Returns

Task

CheckinBatch(Batch, string, CheckinType)

Checks in the file.

The check in comment. The type of check in to use. The batch instance to use.

void CheckinBatch(Batch batch, string comment = null, CheckinType checkinType = CheckinType.MinorCheckIn)

Parameters

batch Batch

comment string

checkinType CheckinType

CheckinBatch(string, CheckinType)

Checks in the file.

The check in comment. The type of check in to use.

void CheckinBatch(string comment = null, CheckinType checkinType = CheckinType.MinorCheckIn)

Parameters

comment string

checkinType CheckinType

CheckinBatchAsync(Batch, string, CheckinType)

Checks in the file.

The check in comment. The type of check in to use. The batch instance to use.

Task CheckinBatchAsync(Batch batch, string comment = null, CheckinType checkinType = CheckinType.MinorCheckIn)

Parameters

batch Batch

comment string

checkinType CheckinType

Returns

Task

CheckinBatchAsync(string, CheckinType)

Checks in the file.

The check in comment. The type of check in to use.

Task CheckinBatchAsync(string comment = null, CheckinType checkinType = CheckinType.MinorCheckIn)

Parameters

comment string

checkinType CheckinType

Returns

Task

Checkout()

Checks out the file.

void Checkout()

CheckoutAsync()

Checks out the file.

Task CheckoutAsync()

Returns

Task

CheckoutBatch()

Checks out the file.

void CheckoutBatch()

CheckoutBatch(Batch)

Checks out the file.

The batch instance to use.

void CheckoutBatch(Batch batch)

Parameters

batch Batch

CheckoutBatchAsync()

Checks out the file.

Task CheckoutBatchAsync()

Returns

Task

CheckoutBatchAsync(Batch)

Checks out the file.

The batch instance to use.

Task CheckoutBatchAsync(Batch batch)

Parameters

batch Batch

Returns

Task

ClassifyAndExtract()

Requests Syntex AI models to classify and extract information from this file

ISyntexClassifyAndExtractResult ClassifyAndExtract()

Returns

ISyntexClassifyAndExtractResult

Information about the classify and extract request

ClassifyAndExtractAsync()

Requests Syntex AI models to classify and extract information from this file

Task<ISyntexClassifyAndExtractResult> ClassifyAndExtractAsync()

Returns

Task<ISyntexClassifyAndExtractResult>

Information about the classify and extract request

ClassifyAndExtractBatch()

Requests Syntex AI models to classify and extract information from this file

IBatchSingleResult<ISyntexClassifyAndExtractResult> ClassifyAndExtractBatch()

Returns

IBatchSingleResult<ISyntexClassifyAndExtractResult>

Information about the classify and extract request

ClassifyAndExtractBatch(Batch)

Requests Syntex AI models to classify and extract information from this file

IBatchSingleResult<ISyntexClassifyAndExtractResult> ClassifyAndExtractBatch(Batch batch)

Parameters

batch Batch

Batch to add this request to

Returns

IBatchSingleResult<ISyntexClassifyAndExtractResult>

Information about the classify and extract request

ClassifyAndExtractBatchAsync()

Requests Syntex AI models to classify and extract information from this file

Task<IBatchSingleResult<ISyntexClassifyAndExtractResult>> ClassifyAndExtractBatchAsync()

Returns

Task<IBatchSingleResult<ISyntexClassifyAndExtractResult>>

Information about the classify and extract request

ClassifyAndExtractBatchAsync(Batch)

Requests Syntex AI models to classify and extract information from this file

Task<IBatchSingleResult<ISyntexClassifyAndExtractResult>> ClassifyAndExtractBatchAsync(Batch batch)

Parameters

batch Batch

Batch to add this request to

Returns

Task<IBatchSingleResult<ISyntexClassifyAndExtractResult>>

Information about the classify and extract request

ConvertTo(ConvertToOptions)

Converts the file to PDF, JPG, Html or Glb

Stream ConvertTo(ConvertToOptions options)

Parameters

options ConvertToOptions

Defines the file conversion options

Returns

Stream

Stream of the converted file

ConvertToAsync(ConvertToOptions)

Converts the file to PDF, JPG, Html or Glb

Task<Stream> ConvertToAsync(ConvertToOptions options)

Parameters

options ConvertToOptions

Defines the file conversion options

Returns

Task<Stream>

Stream of the converted file

CopyTo(string, bool, MoveCopyOptions)

Copies a file to the destination URL.

void CopyTo(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null)

Parameters

destinationUrl string

The destination URL including file name.

overwrite bool

Indicates whether the file should be overwritten if already existing.

options MoveCopyOptions

Options of the copy operation.

CopyToAsync(string, bool, MoveCopyOptions)

Copies a file to the destination URL.

Task CopyToAsync(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null)

Parameters

destinationUrl string

The destination URL including file name.

overwrite bool

Indicates whether the file should be overwritten if already existing.

options MoveCopyOptions

Options of the copy operation.

Returns

Task

CopyToBatch(Batch, string, bool, MoveCopyOptions)

Copies a file to the destination URL.

void CopyToBatch(Batch batch, string destinationUrl, bool overwrite = false, MoveCopyOptions options = null)

Parameters

batch Batch

The batch instance to use.

destinationUrl string

The destination URL including file name.

overwrite bool

Indicates whether the file should be overwritten if already existing.

options MoveCopyOptions

Options of the copy operation.

CopyToBatch(string, bool, MoveCopyOptions)

Copies a file to the destination URL.

void CopyToBatch(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null)

Parameters

destinationUrl string

The destination URL including file name.

overwrite bool

Indicates whether the file should be overwritten if already existing.

options MoveCopyOptions

Options of the copy operation.

CopyToBatchAsync(Batch, string, bool, MoveCopyOptions)

Copies a file to the destination URL.

Task CopyToBatchAsync(Batch batch, string destinationUrl, bool overwrite = false, MoveCopyOptions options = null)

Parameters

batch Batch

The batch instance to use.

destinationUrl string

The destination URL including file name.

overwrite bool

Indicates whether the file should be overwritten if already existing.

options MoveCopyOptions

Options of the copy operation.

Returns

Task

CopyToBatchAsync(string, bool, MoveCopyOptions)

Copies a file to the destination URL.

Task CopyToBatchAsync(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null)

Parameters

destinationUrl string

The destination URL including file name.

overwrite bool

Indicates whether the file should be overwritten if already existing.

options MoveCopyOptions

Options of the copy operation.

Returns

Task

CreateAnonymousSharingLink(AnonymousLinkOptions)

Creates an anonymous sharing link for a file

IGraphPermission CreateAnonymousSharingLink(AnonymousLinkOptions anonymousLinkOptions)

Parameters

anonymousLinkOptions AnonymousLinkOptions

Returns

IGraphPermission

Permission that has been created

CreateAnonymousSharingLinkAsync(AnonymousLinkOptions)

Creates an anonymous sharing link for a file

Task<IGraphPermission> CreateAnonymousSharingLinkAsync(AnonymousLinkOptions anonymousLinkOptions)

Parameters

anonymousLinkOptions AnonymousLinkOptions

Returns

Task<IGraphPermission>

Permission that has been created

CreateOrganizationalSharingLink(OrganizationalLinkOptions)

Creates an organization sharing link for a file

IGraphPermission CreateOrganizationalSharingLink(OrganizationalLinkOptions organizationalLinkOptions)

Parameters

organizationalLinkOptions OrganizationalLinkOptions

Returns

IGraphPermission

Permission that has been created

CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions)

Creates an organization sharing link for a file

Task<IGraphPermission> CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions organizationalLinkOptions)

Parameters

organizationalLinkOptions OrganizationalLinkOptions

Returns

Task<IGraphPermission>

Permission that has been created

CreateSharingInvite(InviteOptions)

Creates a sharing invite to a specific user

IGraphPermission CreateSharingInvite(InviteOptions inviteOptions)

Parameters

inviteOptions InviteOptions

Returns

IGraphPermission

Permission that has been created

CreateSharingInviteAsync(InviteOptions)

Creates a sharing invite to a specific user

Task<IGraphPermission> CreateSharingInviteAsync(InviteOptions inviteOptions)

Parameters

inviteOptions InviteOptions

Returns

Task<IGraphPermission>

Permission that has been created

CreateUserSharingLink(UserLinkOptions)

Creates a user sharing link for a file

IGraphPermission CreateUserSharingLink(UserLinkOptions userLinkOptions)

Parameters

userLinkOptions UserLinkOptions

Returns

IGraphPermission

Permission that has been created

CreateUserSharingLinkAsync(UserLinkOptions)

Creates a user sharing link for a file

Task<IGraphPermission> CreateUserSharingLinkAsync(UserLinkOptions userLinkOptions)

Parameters

userLinkOptions UserLinkOptions

Returns

Task<IGraphPermission>

Permission that has been created

DeleteShareLinks()

Deletes the share links on the file item

void DeleteShareLinks()

DeleteShareLinksAsync()

Deletes the share links on the file item

Task DeleteShareLinksAsync()

Returns

Task

GetAnalytics(AnalyticsOptions)

Gets file analytics

List<IActivityStat> GetAnalytics(AnalyticsOptions options = null)

Parameters

options AnalyticsOptions

Defines which analytics are needed

Returns

List<IActivityStat>

The requested analytics data

GetAnalyticsAsync(AnalyticsOptions)

Gets file analytics

Task<List<IActivityStat>> GetAnalyticsAsync(AnalyticsOptions options = null)

Parameters

options AnalyticsOptions

Defines which analytics are needed

Returns

Task<List<IActivityStat>>

The requested analytics data

GetContent(bool)

Get the content of the file.

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 the file.

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.

byte[] GetContentBytes()

Returns

byte[]

The binary content of the file

GetContentBytesAsync()

Get the content of the file.

Task<byte[]> GetContentBytesAsync()

Returns

Task<byte[]>

The binary content of the file

GetPreview(PreviewOptions)

This action allows you to obtain short-lived embeddable URLs for an item in order to render a temporary preview. The 'page' and 'zoom' options may not be available for all preview apps, but will be applied if the preview app supports it.

IFilePreview GetPreview(PreviewOptions options = null)

Parameters

options PreviewOptions

Options for configuring the created preview URL

Returns

IFilePreview

FilePreview object. Either getUrl, postUrl, or both might be returned depending on the current state of embed support for the specified options.

GetPreviewAsync(PreviewOptions)

This action allows you to obtain short-lived embeddable URLs for an item in order to render a temporary preview. The 'page' and 'zoom' options may not be available for all preview apps, but will be applied if the preview app supports it.

Task<IFilePreview> GetPreviewAsync(PreviewOptions options = null)

Parameters

options PreviewOptions

Options for configuring the created preview URL

Returns

Task<IFilePreview>

FilePreview object. Either getUrl, postUrl, or both might be returned depending on the current state of embed support for the specified options.

GetShareLinks()

Gets the share links on the file item

IGraphPermissionCollection GetShareLinks()

Returns

IGraphPermissionCollection

Collection of share links existing on the file

GetShareLinksAsync()

Gets the share links on the file item

Task<IGraphPermissionCollection> GetShareLinksAsync()

Returns

Task<IGraphPermissionCollection>

Collection of share links existing on the file

GetThumbnails(ThumbnailOptions)

Returns a list of thumbnails for this file

List<IThumbnail> GetThumbnails(ThumbnailOptions options = null)

Parameters

options ThumbnailOptions

Optionally specify which thumbnails you need

Returns

List<IThumbnail>

The requested thumbnails

GetThumbnailsAsync(ThumbnailOptions)

Returns a list of thumbnails for this file

Task<List<IThumbnail>> GetThumbnailsAsync(ThumbnailOptions options = null)

Parameters

options ThumbnailOptions

Optionally specify which thumbnails you need

Returns

Task<List<IThumbnail>>

The requested thumbnails

GetThumbnailsBatch(ThumbnailOptions)

Returns a list of thumbnails for this file

IEnumerableBatchResult<IThumbnail> GetThumbnailsBatch(ThumbnailOptions options = null)

Parameters

options ThumbnailOptions

Optionally specify which thumbnails you need

Returns

IEnumerableBatchResult<IThumbnail>

The requested thumbnails

GetThumbnailsBatch(Batch, ThumbnailOptions)

Returns a list of thumbnails for this file

IEnumerableBatchResult<IThumbnail> GetThumbnailsBatch(Batch batch, ThumbnailOptions options = null)

Parameters

batch Batch

The batch instance to use.

options ThumbnailOptions

Optionally specify which thumbnails you need

Returns

IEnumerableBatchResult<IThumbnail>

The requested thumbnails

GetThumbnailsBatchAsync(ThumbnailOptions)

Returns a list of thumbnails for this file

Task<IEnumerableBatchResult<IThumbnail>> GetThumbnailsBatchAsync(ThumbnailOptions options = null)

Parameters

options ThumbnailOptions

Optionally specify which thumbnails you need

Returns

Task<IEnumerableBatchResult<IThumbnail>>

The requested thumbnails

GetThumbnailsBatchAsync(Batch, ThumbnailOptions)

Returns a list of thumbnails for this file

Task<IEnumerableBatchResult<IThumbnail>> GetThumbnailsBatchAsync(Batch batch, ThumbnailOptions options = null)

Parameters

batch Batch

The batch instance to use.

options ThumbnailOptions

Optionally specify which thumbnails you need

Returns

Task<IEnumerableBatchResult<IThumbnail>>

The requested thumbnails

MoveTo(string, MoveOperations, MoveCopyOptions)

Move a file to the destination URL.

void MoveTo(string destinationUrl, MoveOperations moveOperations = MoveOperations.None, MoveCopyOptions options = null)

Parameters

destinationUrl string

The destination URL including file name.

moveOperations MoveOperations

combinable flags to indicate the type of move operations.

options MoveCopyOptions

Options of the move operation.

Remarks

If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations.

MoveToAsync(string, MoveOperations, MoveCopyOptions)

Move a file to the destination URL.

Task MoveToAsync(string destinationUrl, MoveOperations moveOperations = MoveOperations.None, MoveCopyOptions options = null)

Parameters

destinationUrl string

The destination URL including file name.

moveOperations MoveOperations

combinable flags to indicate the type of move operations.

options MoveCopyOptions

Options of the move operation.

Returns

Task

Remarks

If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations.

MoveToBatch(Batch, string, MoveOperations, MoveCopyOptions)

Move a file to the destination URL.

void MoveToBatch(Batch batch, string destinationUrl, MoveOperations moveOperations = MoveOperations.None, MoveCopyOptions options = null)

Parameters

batch Batch

The batch instance to use.

destinationUrl string

The destination URL including file name.

moveOperations MoveOperations

combinable flags to indicate the type of move operations.

options MoveCopyOptions

Options of the move operation.

Remarks

If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations.

MoveToBatch(string, MoveOperations, MoveCopyOptions)

Move a file to the destination URL.

void MoveToBatch(string destinationUrl, MoveOperations moveOperations = MoveOperations.None, MoveCopyOptions options = null)

Parameters

destinationUrl string

The destination URL including file name.

moveOperations MoveOperations

combinable flags to indicate the type of move operations.

options MoveCopyOptions

Options of the move operation.

Remarks

If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations.

MoveToBatchAsync(Batch, string, MoveOperations, MoveCopyOptions)

Move a file to the destination URL.

Task MoveToBatchAsync(Batch batch, string destinationUrl, MoveOperations moveOperations = MoveOperations.None, MoveCopyOptions options = null)

Parameters

batch Batch

The batch instance to use.

destinationUrl string

The destination URL including file name.

moveOperations MoveOperations

combinable flags to indicate the type of move operations.

options MoveCopyOptions

Options of the move operation.

Returns

Task

Remarks

If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations.

MoveToBatchAsync(string, MoveOperations, MoveCopyOptions)

Move a file to the destination URL.

Task MoveToBatchAsync(string destinationUrl, MoveOperations moveOperations = MoveOperations.None, MoveCopyOptions options = null)

Parameters

destinationUrl string

The destination URL including file name.

moveOperations MoveOperations

combinable flags to indicate the type of move operations.

options MoveCopyOptions

Options of the move operation.

Returns

Task

Remarks

If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations.

Publish(string)

Publish a major version of the current file.

The comments to add on file publishing.

void Publish(string comment = null)

Parameters

comment string

PublishAsync(string)

Publish a major version of the current file.

The comments to add on file publishing.

Task PublishAsync(string comment = null)

Parameters

comment string

Returns

Task

PublishBatch(Batch, string)

Publish a major version of the current file.

The batch instance to use. The comments to add on file publishing.

void PublishBatch(Batch batch, string comment = null)

Parameters

batch Batch

comment string

PublishBatch(string)

Publish a major version of the current file.

The comments to add on file publishing.

void PublishBatch(string comment = null)

Parameters

comment string

PublishBatchAsync(Batch, string)

Publish a major version of the current file.

The batch instance to use. The comments to add on file publishing.

Task PublishBatchAsync(Batch batch, string comment = null)

Parameters

batch Batch

comment string

Returns

Task

PublishBatchAsync(string)

Publish a major version of the current file.

The comments to add on file publishing.

Task PublishBatchAsync(string comment = null)

Parameters

comment string

Returns

Task

Recycle()

Send the file to recycle bin.

Guid Recycle()

Returns

Guid

The Id of the created recycle bin item

RecycleAsync()

Send the file to recycle bin.

Task<Guid> RecycleAsync()

Returns

Task<Guid>

The Id of the created recycle bin item

RecycleBatch()

Send the file to recycle bin.

IBatchSingleResult<BatchResultValue<Guid>> RecycleBatch()

Returns

IBatchSingleResult<BatchResultValue<Guid>>

RecycleBatch(Batch)

Send the file to recycle bin

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

Parameters

batch Batch

The batch instance to use.

Returns

IBatchSingleResult<BatchResultValue<Guid>>

RecycleBatchAsync()

Send the file to recycle bin.

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

Returns

Task<IBatchSingleResult<BatchResultValue<Guid>>>

RecycleBatchAsync(Batch)

Send the file to recycle bin.

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

Parameters

batch Batch

The batch instance to use.

Returns

Task<IBatchSingleResult<BatchResultValue<Guid>>>

Rename(string)

Renames a file

void Rename(string name)

Parameters

name string

New file name

RenameAsync(string)

Renames a file

Task RenameAsync(string name)

Parameters

name string

New file name

Returns

Task

UndoCheckout()

Release the checked out file without saving the changes.

void UndoCheckout()

UndoCheckoutAsync()

Release the checked out file without saving the changes.

Task UndoCheckoutAsync()

Returns

Task

UndoCheckoutBatch()

Release the checked out file without saving the changes.

void UndoCheckoutBatch()

UndoCheckoutBatch(Batch)

Release the checked out file without saving the changes.

The batch instance to use.

void UndoCheckoutBatch(Batch batch)

Parameters

batch Batch

UndoCheckoutBatchAsync()

Release the checked out file without saving the changes.

Task UndoCheckoutBatchAsync()

Returns

Task

UndoCheckoutBatchAsync(Batch)

Release the checked out file without saving the changes.

The batch instance to use.

Task UndoCheckoutBatchAsync(Batch batch)

Parameters

batch Batch

Returns

Task

Unpublish(string)

Unpublish the latest major version of the current file.

The comments to add on file unpublishing.

void Unpublish(string comment = null)

Parameters

comment string

UnpublishAsync(string)

Unpublish the latest major version of the current file.

The comments to add on file unpublishing.

Task UnpublishAsync(string comment = null)

Parameters

comment string

Returns

Task

UnpublishBatch(Batch, string)

Unpublish the latest major version of the current file.

The batch instance to use. The comments to add on file unpublishing.

void UnpublishBatch(Batch batch, string comment = null)

Parameters

batch Batch

comment string

UnpublishBatch(string)

Unpublish the latest major version of the current file.

The comments to add on file unpublishing.

void UnpublishBatch(string comments = null)

Parameters

comments string

UnpublishBatchAsync(Batch, string)

Unpublish the latest major version of the current file.

The batch instance to use. The comments to add on file unpublishing.

Task UnpublishBatchAsync(Batch batch, string comment = null)

Parameters

batch Batch

comment string

Returns

Task

UnpublishBatchAsync(string)

Unpublish the latest major version of the current file.

The comments to add on file unpublishing.

Task UnpublishBatchAsync(string comment = null)

Parameters

comment string

Returns

Task