Click or drag to resize

IFolder Interface

IT Hit WebDAV Classes Reference
Represents a folder in a WebDAV repository.

Namespace:  ITHit.WebDAV.Client
Assembly:  ITHit.WebDAV.Client (in ITHit.WebDAV.Client.dll) Version: 5.1.2712
Syntax
public interface IFolder : IHierarchyItem

public interface IFolder : IHierarchyItem

The IFolder type exposes the following members.

Properties
  NameDescription
Public propertyCode exampleActiveLocks
Array of item's lock descriptions.
(Inherited from IHierarchyItem.)
Public propertyCreationDate
The date item was created.
(Inherited from IHierarchyItem.)
Public propertyDisplayName
User friendly item name.
(Inherited from IHierarchyItem.)
Public propertyHref
This item path on the server.
(Inherited from IHierarchyItem.)
Public propertyItemType
Type of the item (File, Folder, Version or VersionHistory)
(Inherited from IHierarchyItem.)
Public propertyLastModified
Most recent modification date.
(Inherited from IHierarchyItem.)
Public propertyCode exampleProperties (Inherited from IHierarchyItem.)
Public propertySupportedLock
Lock types supported by the item.
(Inherited from IHierarchyItem.)
Top
Methods
  NameDescription
Public methodCode exampleCopyToAsync
Copies this item to destination folder.
(Inherited from IHierarchyItem.)
Public methodCode exampleCreateFileAsync(String)
Creates a file with a specified name.
Public methodCreateFileAsync(String, LockUriTokenPair)
Public methodCode exampleCreateFolderAsync(String)
Creates new folder with specified name as child of this one.
Public methodCode exampleCreateFolderAsync(String, LockUriTokenPair)
Creates new folder with specified name as child of this one.
Public methodCode exampleCreateLockNullAsync(String, TimeSpan, String, Boolean)
Locks name for later use.
Public methodCode exampleCreateLockNullAsync(String, LockScope, Boolean, String, TimeSpan)
Locks name for later use.
Public methodCode exampleDeleteAsync
Deletes this item.
(Inherited from IHierarchyItem.)
Public methodDeleteAsync(String)
Deletes this item.
(Inherited from IHierarchyItem.)
Public methodCode exampleDeleteAsync(LockUriTokenPair)
Deletes this item.
(Inherited from IHierarchyItem.)
Public methodCode exampleGetActiveLocksAsync Obsolete.
Retrieves lock information about this item.
(Inherited from IHierarchyItem.)
Public methodCode exampleGetAllPropertiesAsync
Retrieves all custom properties exposed by the item.
(Inherited from IHierarchyItem.)
Public methodCode exampleGetChildrenAsync
Returns children of this folder.
Public methodGetCommentAsync
Brief comment about an item that is suitable for presentation to a user.
(Inherited from IHierarchyItem.)
Public methodGetCreatorDisplayNameAsync
Contains a description of the creator of the item that is suitable for presentation to a user.
(Inherited from IHierarchyItem.)
Public methodCode exampleGetFileAsync
Gets the specified file from server.
Public methodCode exampleGetFolderAsync
Gets the specified folder from server.
Public methodCode exampleGetItemAsync
Returns IHierarchyItem corresponding to name.
Public methodCode exampleGetParentAsync
Retrieves parent hierarchy item of this item.
(Inherited from IHierarchyItem.)
Public methodCode exampleGetPropertyNamesAsync
Returns names of all custom properties exposed by this item.
(Inherited from IHierarchyItem.)
Public methodCode exampleGetPropertyValuesAsync
Retrieves values of specific properties.
(Inherited from IHierarchyItem.)
Public methodGetSourceAsync
Retrieves media type independent links.
(Inherited from IHierarchyItem.)
Public methodGetSupportedLockAsync Obsolete.
Retrieves information about supported locks.
(Inherited from IHierarchyItem.)
Public methodCode exampleItemExistsAsync
Checks whether specified item exists in the folder.
Public methodCode exampleLockAsync
Locks the item.
(Inherited from IHierarchyItem.)
Public methodCode exampleMoveToAsync(IFolder, String, Boolean)
Moves this item to another location.
(Inherited from IHierarchyItem.)
Public methodCode exampleMoveToAsync(IFolder, String, Boolean, LockUriTokenPair)
Moves this item to another location.
(Inherited from IHierarchyItem.)
Public methodCode exampleRefreshAsync
Rereads item properties from server.
(Inherited from IHierarchyItem.)
Public methodCode exampleRefreshLockAsync
Prolongs the lock.
(Inherited from IHierarchyItem.)
Public methodCode exampleSearchByQueryAsync
Returns array of IHierarchyItem corresponding to searchQuery.
Public methodCode exampleSetCommentAndAuthorAsync(String, String)
Updates comment and author information.
(Inherited from IHierarchyItem.)
Public methodSetCommentAndAuthorAsync(String, String, String)
Updates comment and author information.
(Inherited from IHierarchyItem.)
Public methodCode exampleSupportedFeaturesAsync
Gets the information about functionality supported by server (Class 1, Class 2 and so on).
(Inherited from IHierarchyItem.)
Public methodCode exampleUnlockAsync(String)
Remove the locks.
(Inherited from IHierarchyItem.)
Public methodUnlockAsync(LockUriTokenPair)
Removes the locks. For details UnlockAsync(String).
(Inherited from IHierarchyItem.)
Public methodCode exampleUpdatePropertiesAsync(Property, PropertyName)
Updates values of properties exposed by this item.
(Inherited from IHierarchyItem.)
Public methodCode exampleUpdatePropertiesAsync(Property, PropertyName, String)
Updates values of properties exposed by this item.
(Inherited from IHierarchyItem.)
Top
Examples
The following example demonstrates how to upload a file from local file system to a WebDAV server.
string license = "<?xml version='1.0' encoding='utf...
WebDavSessionAsync session = new WebDavSessionAsync(license);
session.Credentials = new NetworkCredential("User1", "pwd");
IFolder folder = await session.GetFolderAsync(new Uri("https://server:8080/Sales"));

IFile file = await folder.CreateFileAsync("products.xlsx");
file.AllowWriteStreamBuffering = false;
file.TimeOut = 36000000; // 10 hours
await file.UploadAsync("C:\\products.xlsx");
See Also