Class: Version

Extends

• ITHit.WebDAV.Client.File

Members

Comment :string

Comment

ContentLength :number

ContentLength

Length of the file.

ContentType :string

ContentType

Content type of the file.

CreationDate :Date

CreationDate

The date item was created.

CreatorDisplayName :string

CreatorDisplayName

DisplayName :string

DisplayName

User friendly item name.

Href :string

Href

This item path on the server.

Properties :ITHit.WebDAV.Client.PropertyList

Properties

List of item properties.

Session :ITHit.WebDAV.Client.WebDavSession

Session

Current WebDAV session.

VersionName :string

VersionName

This property contains a server-defined string that is different for each version. This string is intended for display for a user.

Methods

DeleteAsync(fCallback) → {ITHit.WebDAV.Client.Request}

DeleteAsync

Delete version by self href.

Name	Type	Description
fCallback	ITHit.WebDAV.Client.Version~DeleteAsyncCallback	Function to call when operation is completed.

Returns:

ITHit.WebDAV.Client.Request

Request object.

ReadContentAsync(iBytesFrom, iBytesCount, fCallback) → {ITHit.WebDAV.Client.Request}

ReadContentAsync

Read file content. To download only a part of a file you can specify 2 parameters in ReadContent call. First parameter is the starting byte (zero-based) at witch to start content download, the second – amount of bytes to be downloaded. The library will add Range header to the request in this case.

Name	Type	Description
iBytesFrom	number	Start position to retrieve lBytesCount number of bytes from.
iBytesCount	number	Number of bytes to retrieve.
fCallback	ITHit.WebDAV.Client.File~ReadContentAsyncCallback	Function to call when operation is completed.

Returns:

ITHit.WebDAV.Client.Request

Request object.

Examples

JavaScript TypeScript

var webDavSession = new ITHit.WebDAV.Client.WebDavSession();
var sFolderAbsolutePath = 'http://localhost:87654/myfile.txt';
var fCallback = function() {};

webDavSession.OpenFileAsync(sFolderAbsolutePath, null, function(oFileAsyncResult) {

    /** @typedef {ITHit.WebDAV.Client.File} oFile */
    var oFile = oFileAsyncResult.Result;

    oFile.GetVersionsAsync(function(oVersionsAsyncResult) {

        /** @typedef {ITHit.WebDAV.Client.Version[]} aVersions */
        var aVersions = oVersionsAsyncResult.Result;

        /** @typedef {ITHit.WebDAV.Client.Version} oVersion */
        var oVersion = aVersions[0];

        oVersion.ReadContentAsync(null, null, function(oAsyncResult) {

            /** @typedef {String} sContent */
            var sContent = oAsyncResult.Result;

            console.log('Version ' + oVersion.VersionName + ', content:' + sContent);

            fCallback(oAsyncResult);
        });
    });
});

import { ITHit } from "webdav.client";

const webDavSession = new ITHit.WebDAV.Client.WebDavSession();
const sFolderAbsolutePath = "http://localhost:87654/myfile.txt";
const fCallback = function (oAsyncResult: ITHit.WebDAV.Client.AsyncResult) {};

webDavSession.OpenFileAsync(sFolderAbsolutePath, null, function (oFileAsyncResult) {
  const oFile: ITHit.WebDAV.Client.File = oFileAsyncResult.Result;

  oFile.GetVersionsAsync(function (oVersionsAsyncResult) {
    const aVersions: ITHit.WebDAV.Client.Version[] = oVersionsAsyncResult.Result;

    const oVersion: ITHit.WebDAV.Client.Version = aVersions[0];

    oVersion.ReadContentAsync(null, null, function (oAsyncResult) {
      const sContent: string = oAsyncResult.Result;

      console.log("Version " + oVersion.VersionName + ", content:" + sContent);

      fCallback(oAsyncResult);
    });
  });
});

RefreshAsync(fCallback) → {ITHit.WebDAV.Client.Request}

RefreshAsync

Refreshes item loading data from server.

Name	Type	Description
fCallback	ITHit.WebDAV.Client.HierarchyItem~RefreshAsyncCallback	Function to call when operation is completed.

Returns:

ITHit.WebDAV.Client.Request

Request object.

UpdateToThisAsync(fCallback) → {ITHit.WebDAV.Client.Request}

UpdateToThisAsync

Update file to current version.

Name	Type	Description
fCallback	ITHit.WebDAV.Client.Version~UpdateToThisVersionAsync	Function to call when operation is completed.

Returns:

ITHit.WebDAV.Client.Request

Request object.

Examples

JavaScript TypeScript

var webDavSession = new ITHit.WebDAV.Client.WebDavSession();
var sFolderAbsolutePath = 'http://localhost:87654/myfile.txt';
var fCallback = function() {};

webDavSession.OpenFileAsync(sFolderAbsolutePath, null, function(oFileAsyncResult) {

    /** @typedef {ITHit.WebDAV.Client.File} oFile */
    var oFile = oFileAsyncResult.Result;

    oFile.GetVersionsAsync(function(oAsyncResult) {

        /** @typedef {ITHit.WebDAV.Client.Version[]} aVersions */
        var aVersions = oAsyncResult.Result;

        /** @typedef {ITHit.WebDAV.Client.Version} oLastVersion */
        var oLastVersion = aVersions[aVersions.length - 1];

        oLastVersion.UpdateToThisAsync(function(oAsyncResult) {

            if (oAsyncResult.IsSuccess) {
                console.log('File `' + oFile.DisplayName + '` successfully updated to version `' + oLastVersion.VersionName + '`');
            }

            fCallback(oAsyncResult);
        });
    });
});

import { ITHit } from "webdav.client";

const webDavSession = new ITHit.WebDAV.Client.WebDavSession();
const sFolderAbsolutePath = "http://localhost:87654/myfile.txt";
const fCallback = function (oAsyncResult: ITHit.WebDAV.Client.AsyncResult) {};

webDavSession.OpenFileAsync(sFolderAbsolutePath, null, function (oFileAsyncResult) {
  const oFile: ITHit.WebDAV.Client.File = oFileAsyncResult.Result;

  oFile.GetVersionsAsync(function (oAsyncResult) {
    const aVersions: ITHit.WebDAV.Client.Version[] = oAsyncResult.Result;

    const oLastVersion: ITHit.WebDAV.Client.Version = aVersions[aVersions.length - 1];

    oLastVersion.UpdateToThisAsync(function (oAsyncResult) {
      if (oAsyncResult.IsSuccess) {
        console.log(
          "File `" +
            oFile.DisplayName +
            "` successfully updated to version `" +
            oLastVersion.VersionName +
            "`"
        );
      }

      fCallback(oAsyncResult);
    });
  });
});

WriteContentAsync(sContent, sLockToken, sMimeType, fCallback) → {ITHit.WebDAV.Client.Request}

WriteContentAsync

Writes file content.

Name	Type	Description
sContent	string	File content.
sLockToken	string	Lock token.
sMimeType	string	File mime-type.
fCallback	ITHit.WebDAV.Client.File~WriteContentAsyncCallback	Function to call when operation is completed.

Returns:

ITHit.WebDAV.Client.Request

Request object.

Type Definitions

DeleteAsyncCallback(oResult)

DeleteAsyncCallback

Callback function to be called when version is deleted on server.

Name	Type	Description
oResult	ITHit.WebDAV.Client.AsyncResult	Result object

UpdateToThisVersionAsync(oResult)

UpdateToThisVersionAsync

Callback function to be called when version is updated on server.

Name	Type	Description
oResult	ITHit.WebDAV.Client.AsyncResult	Result object