Click or drag to resize

IVersionAsync Interface

IT Hit WebDAV Classes Reference
Represents single item version.

Namespace:  ITHit.WebDAV.Server.DeltaV
Assembly:  ITHit.WebDAV.Server (in ITHit.WebDAV.Server.dll) Version: 9.1.5460-Beta
Syntax
public interface IVersionAsync : IDeltaVItemAsync, 
	IHierarchyItemAsync, IHierarchyItemBaseAsync

The IVersionAsync type exposes the following members.

Properties
  NameDescription
Public propertyCode exampleCreated
Gets the creation date of the item in repository expressed as the coordinated universal time (UTC).
(Inherited from IHierarchyItemBaseAsync.)
Public propertyCode exampleModified
Gets the last modification date of the item in repository expressed as the coordinated universal time (UTC).
(Inherited from IHierarchyItemBaseAsync.)
Public propertyCode exampleName
Gets the name of the item in repository.
(Inherited from IHierarchyItemBaseAsync.)
Public propertyCode examplePath
Unique item path in the repository relative to storage root.
(Inherited from IHierarchyItemBaseAsync.)
Public propertyVersionName
Name of the version.
Top
Methods
  NameDescription
Public methodCode exampleCopyToAsync
Creates a copy of this item with a new name in the destination folder.
(Inherited from IHierarchyItemAsync.)
Public methodCode exampleDeleteAsync
Deletes this item.
(Inherited from IHierarchyItemAsync.)
Public methodGetCommentAsync
Retrieves a brief comment about a file that is suitable for presentation to a user.
(Inherited from IDeltaVItemAsync.)
Public methodGetCreatorDisplayNameAsync
Retrieves display name of the user that created this item.
(Inherited from IDeltaVItemAsync.)
Public methodGetPredecessorAsync
Previous version or null if no previous version exists.
Public methodCode exampleGetPropertiesAsync
Gets values of all properties or selected properties for this item.
(Inherited from IHierarchyItemAsync.)
Public methodCode exampleGetPropertyNamesAsync
Gets names of all properties for this item.
(Inherited from IHierarchyItemAsync.)
Public methodGetSuccessorAsync
Next version or null if no next version exists.
Public methodGetVersionableItemAsync
Hierarchy item for this version.
Public methodCode exampleMoveToAsync
Moves this item to the destination folder under a new name.
(Inherited from IHierarchyItemAsync.)
Public methodSetCommentAsync
Sets a brief comment about a file that is suitable for presentation to a user.
(Inherited from IDeltaVItemAsync.)
Public methodSetCreatorDisplayNameAsync
Sets display name of the user that created this item.
(Inherited from IDeltaVItemAsync.)
Public methodCode exampleUpdatePropertiesAsync
Adds, modifies and removes properties for this item.
(Inherited from IHierarchyItemAsync.)
Top
Remarks

Defines the properties and methods that item version must implement. In addition to methods and properties provided by IDeltaVItemAsync this interface also provides methods for getting version name, next version and previous version.

Usually you will implement IVersion interface for your file version objects together with IFileAsync interface. While IFile interface is optional for file versions it may be useful if your DeltaV client application will request content of the file version. In this case [!:IContentAsync.ReadAsync], [!:IContentAsync.ContentLength] and [!:IContentAsync.ContentType] members of the IFileAsync interface will be requested by the engine. Copying, moving, updating properties and content is not allowed for a version, your CopyToAsync(IItemCollectionAsync, String, Boolean, MultistatusException), MoveToAsync(IItemCollectionAsync, String, MultistatusException), UpdatePropertiesAsync(IListPropertyValue, IListPropertyName, MultistatusException) and [!:IContentAsync.WriteAsync] implementations must throw DavException with status NOT_ALLOWED.

Generally from your VersionName implementation you can return any string suitable for displaying to user as a version or the hierarchy item. This string must be unique among versions for this hierarchy item. Usually you will return “1”, “2”, etc or “3.1”, “3.4”, etc.

GetSuccessorAsync and GetPredecessorAsync methods of this interface return next and previous version for the item. The GetVersionableItemAsync method returns the hierarchy item (usually file) to which this version belongs.

See Also