IVersion Interface

IT Hit WebDAV Classes Reference

Represents a single file version.

Namespace: ITHit.WebDAV.Client
Assembly: ITHit.WebDAV.Client (in ITHit.WebDAV.Client.dll) Version: 6.0.4052-Beta

Syntax

C++

Copy

public interface IVersion : IItemContent, 
	IHierarchyItem

Public Interface IVersion
	Inherits IItemContent, IHierarchyItem

public interface class IVersion : IItemContent, 
	IHierarchyItem

type IVersion =  
    interface
        interface IItemContent
        interface IHierarchyItem
    end

The IVersion type exposes the following members.

Properties

	Name	Description
	ActiveLocks	Array of item's lock descriptions. (Inherited from IHierarchyItem.)
	ContentLength	Length of the file content. (Inherited from IItemContent.)
	ContentType	Content type of the file. (Inherited from IItemContent.)
	CreationDate	The date item was created. (Inherited from IHierarchyItem.)
	DisplayName	User friendly item name. (Inherited from IHierarchyItem.)
	Etag	Gets entity tag - string that identifies current state of file's content. (Inherited from IItemContent.)
	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.)
	ResumableUpload	Returns instance of IResumableUpload to manage partially failed uploads. (Inherited from IItemContent.)
	SupportedLock	Lock types supported by the item. (Inherited from IHierarchyItem.)
	VersionName	Name of the version.

Top

Methods

	Name	Description
	CopyToAsync	Copies this item to destination folder. (Inherited from IHierarchyItem.)
	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.)
	DownloadAsync	Downloads content of the file to a file specified by filename. (Inherited from IItemContent.)
	GetActiveLocksAsync	Obsolete. Retrieves lock information about this item. (Inherited from IHierarchyItem.)
	GetAllPropertiesAsync	Retrieves all custom properties exposed by the item. (Inherited from IHierarchyItem.)
	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.)
	GetParentAsync	Retrieves parent hierarchy item of this item. (Inherited from IHierarchyItem.)
	GetPredecessorsAsync	Returns predessors of this version.
	GetPropertyNamesAsync	Returns names of all custom properties exposed by this item. (Inherited from IHierarchyItem.)
	GetPropertyValuesAsync	Retrieves values of specific properties. (Inherited from IHierarchyItem.)
	GetReadStreamAsync	Loads content of the file from WebDAV server. (Inherited from IItemContent.)
	GetReadStreamAsync(Int64, Int64, DateTime)	Loads part of the content of the file from WebDAV server using lastModifiedUtc to ensure the content is up-to-date. (Inherited from IItemContent.)
	GetReadStreamAsync(Int64, Int64, IDictionaryString, String, CancellationToken)	Loads part of the content of the file from WebDAV server. (Inherited from IItemContent.)
	GetReadStreamAsync(Int64, Int64, String, IDictionaryString, String, CancellationToken)	Loads part of the content of the file from WebDAV server using eTag to ensure the content is up-to-date. (Inherited from IItemContent.)
	GetSourceAsync	Retrieves media type independent links. (Inherited from IHierarchyItem.)
	GetSuccessorsAsync	Returns successors of this version.
	GetSupportedLockAsync	Obsolete. Retrieves information about supported locks. (Inherited from IHierarchyItem.)
	GetVersionableItemAsync	IFile item this version relates to.
	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.)
	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.)
	UploadAsync(String, LockUriTokenPair, IDictionaryString, String, CancellationToken)	Uploads content of a file specified by filename to the server. (Inherited from IItemContent.)
	UploadAsync(FuncStream, Task, Int64, LockUriTokenPair, IDictionaryString, String, CancellationToken)	Uploads content of a file specified by function onStreamAvailable to the server. (Inherited from IItemContent.)

Top

Remarks

You can read version content and request properties as you usually do for a file but you cannot update content or properties.

Examples

The following example demonstrates how to list file versions.

Copy

string license = "<?xml version='1.0' encoding='utf...
WebDavSessionAsync session = new WebDavSessionAsync(license);
session.Credentials = new NetworkCredential("User1", "pwd");

IFile file = await session.GetFileAsync(new Uri("https://server/directory/file.docx"));
IVersion[] versions = await file.GetVersionsAsync();
foreach (IVersion version in versions)
{
    MessageBox.Show(version.VersionName);
}

Reference

ITHit.WebDAV.Client Namespace