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: 6.0.4052-Beta

Syntax

C++

Copy

public interface IFolder : IHierarchyItem

Public Interface IFolder
	Inherits IHierarchyItem

public interface class IFolder : IHierarchyItem

type IFolder =  
    interface
        interface IHierarchyItem
    end

The IFolder type exposes the following members.

Properties

	Name	Description
	ActiveLocks	Array of item's lock descriptions. (Inherited from IHierarchyItem.)
	CreationDate	The date item was created. (Inherited from IHierarchyItem.)
	DisplayName	User friendly item name. (Inherited from IHierarchyItem.)
	Href	This item path on the server. (Inherited from IHierarchyItem.)
	ItemType	Type of the item (File, Folder, Version or VersionHistory) (Inherited from IHierarchyItem.)
	LastModified	Most recent modification date. (Inherited from IHierarchyItem.)
	Properties	Custom properties retrieved by [!:IFolder.GetChildrenAsync(bool, PropertyName[])] call. (Inherited from IHierarchyItem.)
	SupportedLock	Lock types supported by the item. (Inherited from IHierarchyItem.)

Top

Methods

	Name	Description
	CopyToAsync	Copies this item to destination folder. (Inherited from IHierarchyItem.)
	CreateFileAsync(String)	Creates a file with a specified name.
	CreateFileAsync(String, LockUriTokenPair, IDictionaryString, String, CancellationToken)
	CreateFolderAsync(String)	Creates new folder with specified name as child of this one.
	CreateFolderAsync(String, LockUriTokenPair)	Creates new folder with specified name as child of this one.
	CreateLockNullAsync(String, TimeSpan, String, Boolean, IDictionaryString, String, CancellationToken)	Locks name for later use.
	CreateLockNullAsync(String, LockScope, Boolean, String, TimeSpan, IDictionaryString, String, CancellationToken)	Locks name for later use.
	DeleteAsync(IDictionaryString, String, CancellationToken)	Deletes this item. (Inherited from IHierarchyItem.)
	DeleteAsync(String, IDictionaryString, String, CancellationToken)	Deletes this item. (Inherited from IHierarchyItem.)
	DeleteAsync(LockUriTokenPair, IDictionaryString, String, CancellationToken)	Deletes this item. (Inherited from IHierarchyItem.)
	GetActiveLocksAsync	Obsolete. Retrieves lock information about this item. (Inherited from IHierarchyItem.)
	GetAllPropertiesAsync	Retrieves all custom properties exposed by the item. (Inherited from IHierarchyItem.)
	GetChildrenAsync	Returns children of this folder.
	GetCommentAsync	Brief comment about an item that is suitable for presentation to a user. (Inherited from IHierarchyItem.)
	GetCreatorDisplayNameAsync	Contains a description of the creator of the item that is suitable for presentation to a user. (Inherited from IHierarchyItem.)
	GetFileAsync	Gets the specified file from server.
	GetFolderAsync	Gets the specified folder from server.
	GetItemAsync	Returns IHierarchyItem corresponding to name.
	GetParentAsync	Retrieves parent hierarchy item of this item. (Inherited from IHierarchyItem.)
	GetPropertyNamesAsync	Returns names of all custom properties exposed by this item. (Inherited from IHierarchyItem.)
	GetPropertyValuesAsync	Retrieves values of specific properties. (Inherited from IHierarchyItem.)
	GetSourceAsync	Retrieves media type independent links. (Inherited from IHierarchyItem.)
	GetSupportedLockAsync	Obsolete. Retrieves information about supported locks. (Inherited from IHierarchyItem.)
	ItemExistsAsync	Checks whether specified item exists in the folder.
	LockAsync	Locks the item. (Inherited from IHierarchyItem.)
	MoveToAsync(IFolder, String, Boolean)	Moves this item to another location. (Inherited from IHierarchyItem.)
	MoveToAsync(IFolder, String, Boolean, LockUriTokenPair)	Moves this item to another location. (Inherited from IHierarchyItem.)
	RefreshAsync	Rereads item properties from server. (Inherited from IHierarchyItem.)
	RefreshLockAsync	Prolongs the lock. (Inherited from IHierarchyItem.)
	SearchByQueryAsync	Returns array of IHierarchyItem corresponding to searchQuery.
	SetCommentAndAuthorAsync(String, String)	Updates comment and author information. (Inherited from IHierarchyItem.)
	SetCommentAndAuthorAsync(String, String, String)	Updates comment and author information. (Inherited from IHierarchyItem.)
	SupportedFeaturesAsync	Gets the information about functionality supported by server (Class 1, Class 2 and so on). (Inherited from IHierarchyItem.)
	UnlockAsync(String, IDictionaryString, String, CancellationToken)	Remove the locks. (Inherited from IHierarchyItem.)
	UnlockAsync(LockUriTokenPair, IDictionaryString, String, CancellationToken)	Removes the locks. For details UnlockAsync(String, IDictionaryString, String, CancellationToken). (Inherited from IHierarchyItem.)
	UpdatePropertiesAsync(Property, PropertyName)	Updates values of properties exposed by this item. (Inherited from IHierarchyItem.)
	UpdatePropertiesAsync(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.

Copy

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");

Reference

ITHit.WebDAV.Client Namespace