Search Results for

    Show / Hide Table of Contents

    Interface IFile

    Public interface to define a File object

    Inherited Members
    IDataModel<IFile>.Requested
    IDataModel<IFile>.HasValue(String)
    IDataModel<IFile>.HasChanged(String)
    IDataModel<IFile>.IsPropertyAvailable(Expression<Func<IFile, Object>>)
    IDataModel<IFile>.ArePropertiesAvailable(Expression<Func<IFile, Object>>[])
    IDataModel<IFile>.EnsureProperties(Expression<Func<IFile, Object>>[])
    IDataModel<IFile>.EnsurePropertiesAsync(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, Expression<Func<IFile, Object>>[])
    IDataModelGet<IFile>.GetAsync(Expression<Func<IFile, Object>>[])
    IDataModelLoad<IFile>.LoadBatchAsync(Batch, Expression<Func<IFile, Object>>[])
    IDataModelLoad<IFile>.LoadAsync(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()
    Namespace: PnP.Core.Model.SharePoint
    Assembly: PnP.Core.dll
    Syntax
    public interface IFile : IDataModel<IFile>, IDataModelParent, IDataModelWithContext, ISupportModules<IFile>, IDataModelGet<IFile>, IDataModelLoad<IFile>, IDataModelUpdate, IDataModelDelete, IQueryableDataModel

    Properties

    All

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

    Declaration
    object All { get; }
    Property Value
    System.Object

    Author

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

    Declaration
    ISharePointUser Author { get; }
    Property Value
    ISharePointUser

    CheckedOutByUser

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

    Declaration
    ISharePointUser CheckedOutByUser { get; }
    Property Value
    ISharePointUser

    CheckInComment

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

    Declaration
    string CheckInComment { get; }
    Property Value
    System.String

    CheckOutType

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

    Declaration
    CheckOutType CheckOutType { get; }
    Property Value
    CheckOutType

    ContentTag

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

    Declaration
    string ContentTag { get; }
    Property Value
    System.String

    CustomizedPageStatus

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

    Declaration
    CustomizedPageStatus CustomizedPageStatus { get; }
    Property Value
    CustomizedPageStatus

    EffectiveInformationRightsManagementSettings

    Gets the Information Rights Management settings of the file.

    Declaration
    IEffectiveInformationRightsManagementSettings EffectiveInformationRightsManagementSettings { get; }
    Property Value
    IEffectiveInformationRightsManagementSettings

    ETag

    Gets a value that specifies the ETag value.

    Declaration
    string ETag { get; }
    Property Value
    System.String

    HasAlternateContentStreams

    Indicates whether this file has alternate streams with content.

    Declaration
    bool HasAlternateContentStreams { get; }
    Property Value
    System.Boolean

    InformationRightsManagementSettings

    Gets the Information Rights Management settings of the file.

    Declaration
    IInformationRightsManagementFileSettings InformationRightsManagementSettings { get; }
    Property Value
    IInformationRightsManagementFileSettings

    IrmEnabled

    Gets or sets whether Irm is enabled on the file.

    Declaration
    bool IrmEnabled { get; set; }
    Property Value
    System.Boolean

    Length

    Gets the file size of the file.

    Declaration
    long Length { get; }
    Property Value
    System.Int64

    Level

    Level of the file (published or draft)

    Declaration
    PublishedStatus Level { get; }
    Property Value
    PublishedStatus

    LinkingUri

    Gets the linking URI of the file.

    Declaration
    string LinkingUri { get; }
    Property Value
    System.String

    LinkingUrl

    Gets the linking URL of the file.

    Declaration
    string LinkingUrl { get; }
    Property Value
    System.String

    ListId

    Gets the id of the list containing the file.

    Declaration
    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.

    Declaration
    IListItem ListItemAllFields { get; }
    Property Value
    IListItem

    LockedByUser

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

    Declaration
    ISharePointUser LockedByUser { get; }
    Property Value
    ISharePointUser

    MajorVersion

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

    Declaration
    int MajorVersion { get; }
    Property Value
    System.Int32

    MinorVersion

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

    Declaration
    int MinorVersion { get; }
    Property Value
    System.Int32

    ModifiedBy

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

    Declaration
    ISharePointUser ModifiedBy { get; }
    Property Value
    ISharePointUser

    Name

    Gets the name of the file including the extension.

    Declaration
    string Name { get; }
    Property Value
    System.String

    PageRenderType

    Gets the list page render type of the file.

    Declaration
    ListPageRenderType PageRenderType { get; }
    Property Value
    ListPageRenderType

    Properties

    Gets the properties of the file.

    Declaration
    IPropertyValues Properties { get; }
    Property Value
    IPropertyValues

    ServerRedirectedUrl

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

    Declaration
    string ServerRedirectedUrl { get; }
    Property Value
    System.String

    ServerRelativeUrl

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

    Declaration
    string ServerRelativeUrl { get; }
    Property Value
    System.String

    SiteId

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

    Declaration
    Guid SiteId { get; }
    Property Value
    Guid

    TimeCreated

    Gets a value that specifies when the file was created.

    Declaration
    DateTime TimeCreated { get; }
    Property Value
    DateTime

    TimeLastModified

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

    Declaration
    DateTime TimeLastModified { get; }
    Property Value
    DateTime

    Title

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

    Declaration
    string Title { get; }
    Property Value
    System.String

    UIVersion

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

    Declaration
    int UIVersion { get; }
    Property Value
    System.Int32

    UIVersionLabel

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

    Declaration
    string UIVersionLabel { get; }
    Property Value
    System.String

    UniqueId

    Gets the unique Id of the file.

    Declaration
    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.

    Declaration
    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 .
    See Requesting model collections and IQueryable performance considerations to learn more.

    Declaration
    IFileVersionCollection Versions { get; }
    Property Value
    IFileVersionCollection

    VroomDriveID

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

    Declaration
    string VroomDriveID { get; }
    Property Value
    System.String

    VroomItemID

    Get the Graph DriveItem ID of the file.

    Declaration
    string VroomItemID { get; }
    Property Value
    System.String

    WebId

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

    Declaration
    Guid WebId { get; }
    Property Value
    Guid

    Methods

    Approve(String)

    Approves the file.

    The approval comment
    Declaration
    void Approve(string comment = null)
    Parameters
    System.String comment

    ApproveAsync(String)

    Approves the file.

    The approval comment
    Declaration
    Task ApproveAsync(string comment = null)
    Parameters
    System.String comment

    Returns
    Task

    ApproveBatch(Batch, String)

    Approves the file.

    The approval comment The batch instance to use.
    Declaration
    void ApproveBatch(Batch batch, string comment = null)
    Parameters
    Batch batch

    System.String comment

    ApproveBatch(String)

    Approves the file.

    The approval comment
    Declaration
    void ApproveBatch(string comment = null)
    Parameters
    System.String comment

    ApproveBatchAsync(Batch, String)

    Approves the file.

    The approval comment The batch instance to use.
    Declaration
    Task ApproveBatchAsync(Batch batch, string comment = null)
    Parameters
    Batch batch

    System.String comment

    Returns
    Task

    ApproveBatchAsync(String)

    Approves the file.

    The approval comment
    Declaration
    Task ApproveBatchAsync(string comment = null)
    Parameters
    System.String comment

    Returns
    Task

    Checkin(String, CheckinType)

    Checks in the file.

    The check in comment. The type of check in to use.
    Declaration
    void Checkin(string comment = null, CheckinType checkinType = default(CheckinType))
    Parameters
    System.String comment

    CheckinType checkinType

    CheckinAsync(String, CheckinType)

    Checks in the file.

    The check in comment. The type of check in to use.
    Declaration
    Task CheckinAsync(string comment = null, CheckinType checkinType = default(CheckinType))
    Parameters
    System.String comment

    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.
    Declaration
    void CheckinBatch(Batch batch, string comment = null, CheckinType checkinType = default(CheckinType))
    Parameters
    Batch batch

    System.String comment

    CheckinType checkinType

    CheckinBatch(String, CheckinType)

    Checks in the file.

    The check in comment. The type of check in to use.
    Declaration
    void CheckinBatch(string comment = null, CheckinType checkinType = default(CheckinType))
    Parameters
    System.String comment

    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.
    Declaration
    Task CheckinBatchAsync(Batch batch, string comment = null, CheckinType checkinType = default(CheckinType))
    Parameters
    Batch batch

    System.String comment

    CheckinType checkinType

    Returns
    Task

    CheckinBatchAsync(String, CheckinType)

    Checks in the file.

    The check in comment. The type of check in to use.
    Declaration
    Task CheckinBatchAsync(string comment = null, CheckinType checkinType = default(CheckinType))
    Parameters
    System.String comment

    CheckinType checkinType

    Returns
    Task

    Checkout()

    Checks out the file.

    Declaration
    void Checkout()

    CheckoutAsync()

    Checks out the file.

    Declaration
    Task CheckoutAsync()
    Returns
    Task

    CheckoutBatch()

    Checks out the file.

    Declaration
    void CheckoutBatch()

    CheckoutBatch(Batch)

    Checks out the file.

    The batch instance to use.
    Declaration
    void CheckoutBatch(Batch batch)
    Parameters
    Batch batch

    CheckoutBatchAsync()

    Checks out the file.

    Declaration
    Task CheckoutBatchAsync()
    Returns
    Task

    CheckoutBatchAsync(Batch)

    Checks out the file.

    The batch instance to use.
    Declaration
    Task CheckoutBatchAsync(Batch batch)
    Parameters
    Batch batch

    Returns
    Task

    ClassifyAndExtract()

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

    Declaration
    ISyntexClassifyAndExtractResult ClassifyAndExtract()
    Returns
    ISyntexClassifyAndExtractResult

    Information about the classify and extract request

    ClassifyAndExtractAsync()

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

    Declaration
    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

    Declaration
    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

    Declaration
    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

    Declaration
    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

    Declaration
    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

    Declaration
    Stream ConvertTo(ConvertToOptions options)
    Parameters
    ConvertToOptions options

    Defines the file conversion options

    Returns
    Stream

    Stream of the converted file

    ConvertToAsync(ConvertToOptions)

    Converts the file to PDF, JPG, Html or Glb

    Declaration
    Task<Stream> ConvertToAsync(ConvertToOptions options)
    Parameters
    ConvertToOptions options

    Defines the file conversion options

    Returns
    Task<Stream>

    Stream of the converted file

    CopyTo(String, Boolean, MoveCopyOptions)

    Copies a file to the destination URL.

    Declaration
    void CopyTo(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null)
    Parameters
    System.String destinationUrl

    The destination URL including file name.

    System.Boolean overwrite

    Indicates whether the file should be overwritten if already existing.

    MoveCopyOptions options

    Options of the copy operation.

    CopyToAsync(String, Boolean, MoveCopyOptions)

    Copies a file to the destination URL.

    Declaration
    Task CopyToAsync(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null)
    Parameters
    System.String destinationUrl

    The destination URL including file name.

    System.Boolean overwrite

    Indicates whether the file should be overwritten if already existing.

    MoveCopyOptions options

    Options of the copy operation.

    Returns
    Task

    CopyToBatch(Batch, String, Boolean, MoveCopyOptions)

    Copies a file to the destination URL.

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

    The batch instance to use.

    System.String destinationUrl

    The destination URL including file name.

    System.Boolean overwrite

    Indicates whether the file should be overwritten if already existing.

    MoveCopyOptions options

    Options of the copy operation.

    CopyToBatch(String, Boolean, MoveCopyOptions)

    Copies a file to the destination URL.

    Declaration
    void CopyToBatch(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null)
    Parameters
    System.String destinationUrl

    The destination URL including file name.

    System.Boolean overwrite

    Indicates whether the file should be overwritten if already existing.

    MoveCopyOptions options

    Options of the copy operation.

    CopyToBatchAsync(Batch, String, Boolean, MoveCopyOptions)

    Copies a file to the destination URL.

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

    The batch instance to use.

    System.String destinationUrl

    The destination URL including file name.

    System.Boolean overwrite

    Indicates whether the file should be overwritten if already existing.

    MoveCopyOptions options

    Options of the copy operation.

    Returns
    Task

    CopyToBatchAsync(String, Boolean, MoveCopyOptions)

    Copies a file to the destination URL.

    Declaration
    Task CopyToBatchAsync(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null)
    Parameters
    System.String destinationUrl

    The destination URL including file name.

    System.Boolean overwrite

    Indicates whether the file should be overwritten if already existing.

    MoveCopyOptions options

    Options of the copy operation.

    Returns
    Task

    CreateAnonymousSharingLink(AnonymousLinkOptions)

    Creates an anonymous sharing link for a file

    Declaration
    IGraphPermission CreateAnonymousSharingLink(AnonymousLinkOptions anonymousLinkOptions)
    Parameters
    AnonymousLinkOptions anonymousLinkOptions

    Returns
    IGraphPermission

    Permission that has been created

    CreateAnonymousSharingLinkAsync(AnonymousLinkOptions)

    Creates an anonymous sharing link for a file

    Declaration
    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

    Declaration
    IGraphPermission CreateOrganizationalSharingLink(OrganizationalLinkOptions organizationalLinkOptions)
    Parameters
    OrganizationalLinkOptions organizationalLinkOptions

    Returns
    IGraphPermission

    Permission that has been created

    CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions)

    Creates an organization sharing link for a file

    Declaration
    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

    Declaration
    IGraphPermission CreateSharingInvite(InviteOptions inviteOptions)
    Parameters
    InviteOptions inviteOptions

    Returns
    IGraphPermission

    Permission that has been created

    CreateSharingInviteAsync(InviteOptions)

    Creates a sharing invite to a specific user

    Declaration
    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

    Declaration
    IGraphPermission CreateUserSharingLink(UserLinkOptions userLinkOptions)
    Parameters
    UserLinkOptions userLinkOptions

    Returns
    IGraphPermission

    Permission that has been created

    CreateUserSharingLinkAsync(UserLinkOptions)

    Creates a user sharing link for a file

    Declaration
    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

    Declaration
    void DeleteShareLinks()

    DeleteShareLinksAsync()

    Deletes the share links on the file item

    Declaration
    Task DeleteShareLinksAsync()
    Returns
    Task

    GetAnalytics(AnalyticsOptions)

    Gets file analytics

    Declaration
    List<IActivityStat> GetAnalytics(AnalyticsOptions options = null)
    Parameters
    AnalyticsOptions options

    Defines which analytics are needed

    Returns
    PnP.Core.Model.SharePoint.List<IActivityStat>

    The requested analytics data

    GetAnalyticsAsync(AnalyticsOptions)

    Gets file analytics

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

    Defines which analytics are needed

    Returns
    Task<PnP.Core.Model.SharePoint.List<IActivityStat>>

    The requested analytics data

    GetContent(Boolean)

    Get the content of the file.

    Declaration
    Stream GetContent(bool streamContent = false)
    Parameters
    System.Boolean streamContent

    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(Boolean)

    Get the content of the file.

    Declaration
    Task<Stream> GetContentAsync(bool streamContent = false)
    Parameters
    System.Boolean streamContent

    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.

    Declaration
    byte[] GetContentBytes()
    Returns
    System.Byte[]

    The binary content of the file

    GetContentBytesAsync()

    Get the content of the file.

    Declaration
    Task<byte[]> GetContentBytesAsync()
    Returns
    Task<System.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.

    Declaration
    IFilePreview GetPreview(PreviewOptions options = null)
    Parameters
    PreviewOptions options

    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.

    Declaration
    Task<IFilePreview> GetPreviewAsync(PreviewOptions options = null)
    Parameters
    PreviewOptions options

    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

    Declaration
    IGraphPermissionCollection GetShareLinks()
    Returns
    IGraphPermissionCollection

    Collection of share links existing on the file

    GetShareLinksAsync()

    Gets the share links on the file item

    Declaration
    Task<IGraphPermissionCollection> GetShareLinksAsync()
    Returns
    Task<IGraphPermissionCollection>

    Collection of share links existing on the file

    GetThumbnails(ThumbnailOptions)

    Returns a list of thumbnails for this file

    Declaration
    List<IThumbnail> GetThumbnails(ThumbnailOptions options = null)
    Parameters
    ThumbnailOptions options

    Optionally specify which thumbnails you need

    Returns
    PnP.Core.Model.SharePoint.List<IThumbnail>

    The requested thumbnails

    GetThumbnailsAsync(ThumbnailOptions)

    Returns a list of thumbnails for this file

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

    Optionally specify which thumbnails you need

    Returns
    Task<PnP.Core.Model.SharePoint.List<IThumbnail>>

    The requested thumbnails

    GetThumbnailsBatch(ThumbnailOptions)

    Returns a list of thumbnails for this file

    Declaration
    IEnumerableBatchResult<IThumbnail> GetThumbnailsBatch(ThumbnailOptions options = null)
    Parameters
    ThumbnailOptions options

    Optionally specify which thumbnails you need

    Returns
    IEnumerableBatchResult<IThumbnail>

    The requested thumbnails

    GetThumbnailsBatch(Batch, ThumbnailOptions)

    Returns a list of thumbnails for this file

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

    The batch instance to use.

    ThumbnailOptions options

    Optionally specify which thumbnails you need

    Returns
    IEnumerableBatchResult<IThumbnail>

    The requested thumbnails

    GetThumbnailsBatchAsync(ThumbnailOptions)

    Returns a list of thumbnails for this file

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

    Optionally specify which thumbnails you need

    Returns
    Task<IEnumerableBatchResult<IThumbnail>>

    The requested thumbnails

    GetThumbnailsBatchAsync(Batch, ThumbnailOptions)

    Returns a list of thumbnails for this file

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

    The batch instance to use.

    ThumbnailOptions options

    Optionally specify which thumbnails you need

    Returns
    Task<IEnumerableBatchResult<IThumbnail>>

    The requested thumbnails

    MoveTo(String, MoveOperations, MoveCopyOptions)

    Move a file to the destination URL.

    Declaration
    void MoveTo(string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null)
    Parameters
    System.String destinationUrl

    The destination URL including file name.

    MoveOperations moveOperations

    combinable flags to indicate the type of move operations.

    MoveCopyOptions options

    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.

    Declaration
    Task MoveToAsync(string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null)
    Parameters
    System.String destinationUrl

    The destination URL including file name.

    MoveOperations moveOperations

    combinable flags to indicate the type of move operations.

    MoveCopyOptions options

    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.

    Declaration
    void MoveToBatch(Batch batch, string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null)
    Parameters
    Batch batch

    The batch instance to use.

    System.String destinationUrl

    The destination URL including file name.

    MoveOperations moveOperations

    combinable flags to indicate the type of move operations.

    MoveCopyOptions options

    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.

    Declaration
    void MoveToBatch(string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null)
    Parameters
    System.String destinationUrl

    The destination URL including file name.

    MoveOperations moveOperations

    combinable flags to indicate the type of move operations.

    MoveCopyOptions options

    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.

    Declaration
    Task MoveToBatchAsync(Batch batch, string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null)
    Parameters
    Batch batch

    The batch instance to use.

    System.String destinationUrl

    The destination URL including file name.

    MoveOperations moveOperations

    combinable flags to indicate the type of move operations.

    MoveCopyOptions options

    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.

    Declaration
    Task MoveToBatchAsync(string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null)
    Parameters
    System.String destinationUrl

    The destination URL including file name.

    MoveOperations moveOperations

    combinable flags to indicate the type of move operations.

    MoveCopyOptions options

    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.
    Declaration
    void Publish(string comment = null)
    Parameters
    System.String comment

    PublishAsync(String)

    Publish a major version of the current file.

    The comments to add on file publishing.
    Declaration
    Task PublishAsync(string comment = null)
    Parameters
    System.String comment

    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.
    Declaration
    void PublishBatch(Batch batch, string comment = null)
    Parameters
    Batch batch

    System.String comment

    PublishBatch(String)

    Publish a major version of the current file.

    The comments to add on file publishing.
    Declaration
    void PublishBatch(string comment = null)
    Parameters
    System.String comment

    PublishBatchAsync(Batch, String)

    Publish a major version of the current file.

    The batch instance to use. The comments to add on file publishing.
    Declaration
    Task PublishBatchAsync(Batch batch, string comment = null)
    Parameters
    Batch batch

    System.String comment

    Returns
    Task

    PublishBatchAsync(String)

    Publish a major version of the current file.

    The comments to add on file publishing.
    Declaration
    Task PublishBatchAsync(string comment = null)
    Parameters
    System.String comment

    Returns
    Task

    Recycle()

    Send the file to recycle bin.

    Declaration
    Guid Recycle()
    Returns
    Guid

    The Id of the created recycle bin item

    RecycleAsync()

    Send the file to recycle bin.

    Declaration
    Task<Guid> RecycleAsync()
    Returns
    Task<Guid>

    The Id of the created recycle bin item

    RecycleBatch()

    Send the file to recycle bin.

    Declaration
    IBatchSingleResult<BatchResultValue<Guid>> RecycleBatch()
    Returns
    IBatchSingleResult<BatchResultValue<Guid>>

    RecycleBatch(Batch)

    Send the file to recycle bin

    Declaration
    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.

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

    RecycleBatchAsync(Batch)

    Send the file to recycle bin.

    Declaration
    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

    Declaration
    void Rename(string name)
    Parameters
    System.String name

    New file name

    RenameAsync(String)

    Renames a file

    Declaration
    Task RenameAsync(string name)
    Parameters
    System.String name

    New file name

    Returns
    Task

    UndoCheckout()

    Release the checked out file without saving the changes.

    Declaration
    void UndoCheckout()

    UndoCheckoutAsync()

    Release the checked out file without saving the changes.

    Declaration
    Task UndoCheckoutAsync()
    Returns
    Task

    UndoCheckoutBatch()

    Release the checked out file without saving the changes.

    Declaration
    void UndoCheckoutBatch()

    UndoCheckoutBatch(Batch)

    Release the checked out file without saving the changes.

    The batch instance to use.
    Declaration
    void UndoCheckoutBatch(Batch batch)
    Parameters
    Batch batch

    UndoCheckoutBatchAsync()

    Release the checked out file without saving the changes.

    Declaration
    Task UndoCheckoutBatchAsync()
    Returns
    Task

    UndoCheckoutBatchAsync(Batch)

    Release the checked out file without saving the changes.

    The batch instance to use.
    Declaration
    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.
    Declaration
    void Unpublish(string comment = null)
    Parameters
    System.String comment

    UnpublishAsync(String)

    Unpublish the latest major version of the current file.

    The comments to add on file unpublishing.
    Declaration
    Task UnpublishAsync(string comment = null)
    Parameters
    System.String comment

    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.
    Declaration
    void UnpublishBatch(Batch batch, string comment = null)
    Parameters
    Batch batch

    System.String comment

    UnpublishBatch(String)

    Unpublish the latest major version of the current file.

    The comments to add on file unpublishing.
    Declaration
    void UnpublishBatch(string comments = null)
    Parameters
    System.String comments

    UnpublishBatchAsync(Batch, String)

    Unpublish the latest major version of the current file.

    The batch instance to use. The comments to add on file unpublishing.
    Declaration
    Task UnpublishBatchAsync(Batch batch, string comment = null)
    Parameters
    Batch batch

    System.String comment

    Returns
    Task

    UnpublishBatchAsync(String)

    Unpublish the latest major version of the current file.

    The comments to add on file unpublishing.
    Declaration
    Task UnpublishBatchAsync(string comment = null)
    Parameters
    System.String comment

    Returns
    Task

    Extension Methods

    DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.Get<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.Load<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.QueryProperties<TModel>(IDataModelLoad<TModel>, 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>>)
    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer