Class: UploaderSession

Extends

• ITHit.WebDAV.Client.WebDavSession

Methods

inherited AddListener(sEventName, fCallback, oContext)

AddListener

Name	Type	Description
sEventName	string
fCallback	function
oContext	object	optional

inherited CreateFolderAsync(sPath, aProperties, fCallback)

CreateFolderAsync

Creates folder corresponding to path.

Name	Type	Description
sPath	string	Path to the resource.
aProperties	Array.<ITHit.WebDAV.Client.PropertyName>	Additional properties requested from server. Default is empty array.
fCallback	ITHit.WebDAV.Client.WebDavSession~CreateFolderAsyncCallback	Function to call when operation is completed.

inherited OpenFileAsync(sPath, aProperties, fCallback) → {ITHit.WebDAV.Client.Request}

OpenFileAsync

Load File object corresponding to path.

Name	Type	Description
sPath	string	Path to the file.
aProperties	Array.<ITHit.WebDAV.Client.PropertyName>	Additional properties requested from server. Default is empty array.
fCallback	ITHit.WebDAV.Client.WebDavSession~OpenFileAsyncCallback	Function to call when operation is completed.

Returns:

ITHit.WebDAV.Client.Request

Request object.

inherited OpenFolderAsync(sPath, aProperties, fCallback)

OpenFolderAsync

Returns Folder object corresponding to path.

Name	Type	Description
sPath	string	Path to the folder.
aProperties	Array.<ITHit.WebDAV.Client.PropertyName>	Additional properties requested from server. Default is empty array.
fCallback	ITHit.WebDAV.Client.WebDavSession~OpenFolderAsyncCallback	Function to call when operation is completed.

Examples

JavaScript TypeScript

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

webDavSession.OpenFolderAsync(sFolderAbsolutePath, null, function(oAsyncResult) {

    /** @typedef {ITHit.WebDAV.Client.Folder} oFolder */
    var oFolder = oAsyncResult.Result;

    console.log('Loaded folder `' + oFolder.DisplayName + '`.');

    fCallback(oAsyncResult);
});

import { ITHit } from "webdav.client";

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

webDavSession.OpenFolderAsync(sFolderAbsolutePath, null, function (oAsyncResult) {
  const oFolder: ITHit.WebDAV.Client.Folder = oAsyncResult.Result;

  console.log("Loaded folder `" + oFolder.DisplayName + "`.");

  fCallback(oAsyncResult);
});

inherited OpenItemAsync(sPath, aProperties, fCallback)

OpenItemAsync

Returns HierarchyItem object corresponding to path.

Name	Type	Description
sPath	string	Path to the resource.
aProperties	Array.<ITHit.WebDAV.Client.PropertyName>	Additional properties requested from server. Default is empty array.
fCallback	ITHit.WebDAV.Client.WebDavSession~OpenItemAsyncCallback	Function to call when operation is completed.

inherited RemoveListener(sEventName, fCallback, oContext)

RemoveListener

Name	Type	Description
sEventName	string
fCallback	function
oContext	object	optional

Events

inherited OnBeforeRequestSend

OnBeforeRequestSend

The OnBeforeRequestSend event is fired before request is being submitted to server and provides all information that is used when creating the request such as URL, HTTP verb, headers and request body.

Properties:

Name	Type	Description
Method	string	Request method
Href	string	Request absolute path
Headers	object	Key-value object with headers
Body	string	Request Body

Examples

JavaScript TypeScript

var webDavSession = new ITHit.WebDAV.Client.WebDavSession();
var fCallback = function() {};

webDavSession.AddListener('OnBeforeRequestSend', function(oEvent) {

    // Add new header
    //oEvent.Headers['My-Header'] = oEvent.Method;

    // Show request info
    console.log(oEvent.Method + ' ' + oEvent.Href);
    for (var sKey in oEvent.Headers) {
        if (oEvent.Headers.hasOwnProperty(sKey)) {
            console.log(sKey + ': ' + oEvent.Headers[sKey]);
        }
    }

    // Show request body
    console.log(oEvent.Body);

    fCallback(oEvent);
});

import { ITHit } from "webdav.client";

const webDavSession = new ITHit.WebDAV.Client.WebDavSession();
const fCallback = function (oEvent: any) {};

webDavSession.AddListener("OnBeforeRequestSend", function (oEvent: any) {
  // Add new header
  //oEvent.Headers['My-Header'] = oEvent.Method;

  // Show request info
  console.log(oEvent.Method + " " + oEvent.Href);
  for (let sKey in oEvent.Headers) {
    if (oEvent.Headers.hasOwnProperty(sKey)) {
      console.log(sKey + ": " + oEvent.Headers[sKey]);
    }
  }

  // Show request body
  console.log(oEvent.Body);

  fCallback(oEvent);
});

inherited OnResponse

OnResponse

The OnResponse event fires when the data is received from server. In your event handler you can update any data received from server.

Properties:

Name	Type	Description
Status	number	Response status code
StatusDescription	string	Response status description
Headers	object	Key-value object with headers
Body	string	Response Body

Examples

JavaScript TypeScript

var webDavSession = new ITHit.WebDAV.Client.WebDavSession();
var fCallback = function() {};

webDavSession.AddListener('OnResponse', function(oEvent) {

    // Show HTTP status and description
    console.log(oEvent.Status + ' ' + oEvent.StatusDescription);

    // Show headers
    for (var sKey in oEvent.Headers) {
        if (oEvent.Headers.hasOwnProperty(sKey)) {
            console.log(sKey + ': ' + oEvent.Headers[sKey]);
        }
    }

    // Show response body
    console.log(oEvent.BodyText);

    fCallback(oEvent);
});

import { ITHit } from "webdav.client";

const webDavSession = new ITHit.WebDAV.Client.WebDavSession();
const fCallback = function (oEvent: any) {};

webDavSession.AddListener("OnResponse", function (oEvent: any) {
  // Show HTTP status and description
  console.log(oEvent.Status + " " + oEvent.StatusDescription);

  // Show headers
  for (let sKey in oEvent.Headers) {
    if (oEvent.Headers.hasOwnProperty(sKey)) {
      console.log(sKey + ": " + oEvent.Headers[sKey]);
    }
  }

  // Show response body
  console.log(oEvent.BodyText);

  fCallback(oEvent);
});