Public interface to define a Folder object
public interface IFolder : IDataModel<IFolder>, IDataModelParent, IDataModelWithContext, ISupportModules<IFolder>, IDataModelGet<IFolder>, IDataModelLoad<IFolder>, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, IQueryableDataModelA special property used to add an asterisk to a $select statement
object All { get; }|
System.Object
|
Default ordered list of content types on a list, before adjustments
IContentTypeIdCollection ContentTypeOrder { get; }|
IContentTypeIdCollection
|
Gets whether the folder exists,
bool Exists { get; }|
System.Boolean
|
Gets the collection of files contained in the folder
IFileCollection Files { get; }|
IFileCollection
|
Gets the collection of list folders contained in the list folder.
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IFolderCollection Folders { get; }|
IFolderCollection
|
Indicate whether the folder is enabled for WOPI default action.
bool IsWOPIEnabled { get; }|
System.Boolean
|
Gets a value that specifies the count of items in the list folder.
int ItemCount { get; }|
System.Int32
|
Gets the list item field values for the list item corresponding to the file.
IListItem ListItemAllFields { get; }|
IListItem
|
Gets the name of the folder.
string Name { get; }|
System.String
|
Gets the parent list folder of the folder.
IFolder ParentFolder { get; }|
IFolder
|
Gets a string that identifies the application in which the folder was created.
string ProgID { get; }|
System.String
|
Gets the collection of all properties defined for this folder.
IPropertyValues Properties { get; }|
IPropertyValues
|
Gets the server-relative URL of the list folder.
string ServerRelativeUrl { get; }|
System.String
|
Get the storage metrics of the folder.
IStorageMetrics StorageMetrics { get; }|
IStorageMetrics
|
Gets the creation time of the folder.
DateTime TimeCreated { get; }|
DateTime
|
Gets the last modification time of the folder.
DateTime TimeLastModified { get; }|
DateTime
|
Ordered list of content types on a list: controls order of items in the "New" menu and "List Settings" page
IContentTypeIdCollection UniqueContentTypeOrder { get; }|
IContentTypeIdCollection
|
Gets the Unique Id of the folder.
Guid UniqueId { get; }|
Guid
|
Gets or sets a value that specifies folder-relative URL for the list folder welcome page.
string WelcomePage { get; set; }|
System.String
|
Add a folder to the current folder.
IFolder AddFolder(string name)|
System.String
name
The name of the folder to add. |
|
IFolder
The added folder. |
Add a folder to the current folder.
Task<IFolder> AddFolderAsync(string name)|
System.String
name
The name of the folder to add. |
|
Task<IFolder>
The added folder. |
Add a folder to the current folder via batch.
IFolder AddFolderBatch(Batch batch, string name)|
Batch
batch
Batch to add the reques to |
|
System.String
name
The name of the folder to add. |
|
IFolder
The added folder. |
Add a folder to the current folder via batch.
IFolder AddFolderBatch(string name)|
System.String
name
The name of the folder to add. |
|
IFolder
The added folder. |
Add a folder to the current folder via batch.
Task<IFolder> AddFolderBatchAsync(Batch batch, string name)|
Batch
batch
Batch to add the reques to |
|
System.String
name
The name of the folder to add. |
|
Task<IFolder>
The added folder. |
Add a folder to the current folder via batch.
Task<IFolder> AddFolderBatchAsync(string name)|
System.String
name
The name of the folder to add. |
|
Task<IFolder>
The added folder. |
Classifies and extracts all unprocessed files in this folder and it's sub folders via the Syntex off-peak queue
ISyntexClassifyAndExtractResult ClassifyAndExtractOffPeak()|
ISyntexClassifyAndExtractResult
Information about the created classify and extract requests |
Classifies and extracts all unprocessed files in this folder and it's sub folders via the Syntex off-peak queue
Task<ISyntexClassifyAndExtractResult> ClassifyAndExtractOffPeakAsync()|
Task<ISyntexClassifyAndExtractResult>
Information about the created classify and extract requests |
Copies a folder to the destination URL.
void CopyTo(string destinationUrl, MoveCopyOptions options = null)|
System.String
destinationUrl
The destination URL. |
|
MoveCopyOptions
options
options of the copy operation. |
Copies a folder to the destination URL.
Task CopyToAsync(string destinationUrl, MoveCopyOptions options = null)|
System.String
destinationUrl
The destination URL. |
|
MoveCopyOptions
options
options of the copy operation. |
|
Task
|
Copies a folder to the destination URL.
void CopyToBatch(Batch batch, string destinationUrl, MoveCopyOptions options = null)|
Batch
batch
The batch instance to use. |
|
System.String
destinationUrl
The destination URL. |
|
MoveCopyOptions
options
options of the copy operation. |
Copies a folder to the destination URL.
void CopyToBatch(string destinationUrl, MoveCopyOptions options = null)|
System.String
destinationUrl
The destination URL. |
|
MoveCopyOptions
options
options of the copy operation. |
Copies a folder to the destination URL.
Task CopyToBatchAsync(Batch batch, string destinationUrl, MoveCopyOptions options = null)|
Batch
batch
The batch instance to use. |
|
System.String
destinationUrl
The destination URL. |
|
MoveCopyOptions
options
options of the copy operation. |
|
Task
|
Copies a folder to the destination URL.
Task CopyToBatchAsync(string destinationUrl, MoveCopyOptions options = null)|
System.String
destinationUrl
The destination URL. |
|
MoveCopyOptions
options
options of the copy operation. |
|
Task
|
Creates an anonymous sharing link for a file
IGraphPermission CreateAnonymousSharingLink(AnonymousLinkOptions anonymousLinkOptions)|
AnonymousLinkOptions
anonymousLinkOptions
|
|
IGraphPermission
Permission that has been created |
Creates an anonymous sharing link for a file
Task<IGraphPermission> CreateAnonymousSharingLinkAsync(AnonymousLinkOptions anonymousLinkOptions)|
AnonymousLinkOptions
anonymousLinkOptions
|
|
Task<IGraphPermission>
Permission that has been created |
Creates an organization sharing link for a file
IGraphPermission CreateOrganizationalSharingLink(OrganizationalLinkOptions organizationalLinkOptions)|
OrganizationalLinkOptions
organizationalLinkOptions
|
|
IGraphPermission
Permission that has been created |
Creates an organization sharing link for a file
Task<IGraphPermission> CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions organizationalLinkOptions)|
OrganizationalLinkOptions
organizationalLinkOptions
|
|
Task<IGraphPermission>
Permission that has been created |
Creates a sharing invite to a specific user
IGraphPermission CreateSharingInvite(InviteOptions inviteOptions)|
InviteOptions
inviteOptions
|
|
IGraphPermission
Permission that has been created |
Creates a sharing invite to a specific user
Task<IGraphPermission> CreateSharingInviteAsync(InviteOptions inviteOptions)|
InviteOptions
inviteOptions
|
|
Task<IGraphPermission>
Permission that has been created |
Creates a user sharing link for a file
IGraphPermission CreateUserSharingLink(UserLinkOptions userLinkOptions)|
UserLinkOptions
userLinkOptions
|
|
IGraphPermission
Permission that has been created |
Creates a user sharing link for a file
Task<IGraphPermission> CreateUserSharingLinkAsync(UserLinkOptions userLinkOptions)|
UserLinkOptions
userLinkOptions
|
|
Task<IGraphPermission>
Permission that has been created |
Deletes the share links on the file item
void DeleteShareLinks()Deletes the share links on the file item
Task DeleteShareLinksAsync()|
Task
|
Ensures a (hierarchy) of folders exists on a given folder
IFolder EnsureFolder(string folderRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)|
System.String
folderRelativeUrl
a (hierarchy) of folders (e.g. folderA/folderB/FolderC) |
|
Expression<Func<IFolder, System.Object>>[]
expressions
Expressions needed to create the request, only used when the folder exists, if the returned folder was newly created the default properties are returned |
|
IFolder
The IFolder representing the final folder in the hierarchy (e.g. FolderC) |
Ensures a (hierarchy) of folders exists on a given folder
Task<IFolder> EnsureFolderAsync(string folderRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)|
System.String
folderRelativeUrl
a (hierarchy) of folders (e.g. folderA/folderB/FolderC) |
|
Expression<Func<IFolder, System.Object>>[]
expressions
Expressions needed to create the request, only used when the folder exists, if the returned folder was newly created the default properties are returned |
|
Task<IFolder>
The IFolder representing the final folder in the hierarchy (e.g. FolderC) |
Find files in the folder, can be slow as it iterates over all the files in the folder and it's sub folders. If performance is key, then try using a search based solution
List<IFile> FindFiles(string match)|
System.String
match
|
|
PnP.Core.Model.SharePoint.List<IFile>
A |
Find files in the folder, can be slow as it iterates over all the files in the folder and it's sub folders. If performance is key, then try using a search based solution
Task<List<IFile>> FindFilesAsync(string match)|
System.String
match
|
|
Task<PnP.Core.Model.SharePoint.List<IFile>>
A |
Gets the share links on the file item
IGraphPermissionCollection GetShareLinks()|
IGraphPermissionCollection
Collection of share links existing on the file |
Gets the share links on the file item
Task<IGraphPermissionCollection> GetShareLinksAsync()|
Task<IGraphPermissionCollection>
Collection of share links existing on the file |
Moves a folder to the destination URL.
void MoveTo(string destinationUrl, MoveCopyOptions options = null)|
System.String
destinationUrl
The destination URL. |
|
MoveCopyOptions
options
options of the move operation. |
Moves a folder to the destination URL.
Task MoveToAsync(string destinationUrl, MoveCopyOptions options = null)|
System.String
destinationUrl
The destination URL. |
|
MoveCopyOptions
options
options of the move operation. |
|
Task
|
Moves a folder to the destination URL.
void MoveToBatch(Batch batch, string destinationUrl, MoveCopyOptions options = null)|
Batch
batch
The batch instance to use. |
|
System.String
destinationUrl
The destination URL. |
|
MoveCopyOptions
options
options of the move operation. |
Moves a folder to the destination URL.
void MoveToBatch(string destinationUrl, MoveCopyOptions options = null)|
System.String
destinationUrl
The destination URL. |
|
MoveCopyOptions
options
options of the move operation. |
Moves a folder to the destination URL.
Task MoveToBatchAsync(Batch batch, string destinationUrl, MoveCopyOptions options = null)|
Batch
batch
The batch instance to use. |
|
System.String
destinationUrl
The destination URL. |
|
MoveCopyOptions
options
options of the move operation. |
|
Task
|
Moves a folder to the destination URL.
Task MoveToBatchAsync(string destinationUrl, MoveCopyOptions options = null)|
System.String
destinationUrl
The destination URL. |
|
MoveCopyOptions
options
options of the move operation. |
|
Task
|
Send the file to recycle bin.
Guid Recycle()|
Guid
The Id of the created recycle bin item |
Send the file to recycle bin.
Task<Guid> RecycleAsync()|
Task<Guid>
The Id of the created recycle bin item |
Send the file to recycle bin.
IBatchSingleResult<BatchResultValue<Guid>> RecycleBatch()|
IBatchSingleResult<BatchResultValue<Guid>>
|
Send the file to recycle bin
IBatchSingleResult<BatchResultValue<Guid>> RecycleBatch(Batch batch)|
Batch
batch
The batch instance to use. |
|
IBatchSingleResult<BatchResultValue<Guid>>
|
Send the file to recycle bin.
Task<IBatchSingleResult<BatchResultValue<Guid>>> RecycleBatchAsync()|
Task<IBatchSingleResult<BatchResultValue<Guid>>>
|
Send the file to recycle bin.
Task<IBatchSingleResult<BatchResultValue<Guid>>> RecycleBatchAsync(Batch batch)|
Batch
batch
The batch instance to use. |
|
Task<IBatchSingleResult<BatchResultValue<Guid>>>
|
Renames a folder
void Rename(string name)|
System.String
name
New folder name |
Renames a folder
Task RenameAsync(string name)|
System.String
name
New folder name |
|
Task
|