WebDAV Library: ITHit.WebDAV.Client.HierarchyItem

  CopyTo(ITHit.WebDAV.Client.Folder oDestinationFolder, String sDestinationName, Boolean bDeep, Boolean bOverwrite, [ITHit.WebDAV.Client.LockUriTokenPair[] mLockTokens])

Copies this item to destination folder.

Parameters:

oDestinationFolder Folder to move to.

sDestinationName Name to assign to copied item.

bDeep Indicates whether children of this item should be copied.

bOverwrite Whether existing destination item shall be overwritten.

mLockTokens (optional) Lock tokens for destination folder.

Throws:

ITHit.WebDAV.Client.Exceptions.ForbiddenException The source and destination URIs are the same.

ITHit.WebDAV.Client.Exceptions.LockedException The destination folder or items to be overwritten were locked.

ITHit.WebDAV.Client.Exceptions.PreconditionFailedException The destination item exists and overwrite was false.

ITHit.WebDAV.Client.Exceptions.NotFoundException This item doesn't exist on the server.

ITHit.WebDAV.Client.Exceptions.WebDavHttpException Server returned unknown error for specific resource.

ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.

function Delete

Delete(ITHit.WebDAV.Client.LockUriTokenPair oLockTokens)

Deletes this item.

Parameters:

oLockTokens Lock tokens for this item or any locked child item.

Throws:

ITHit.WebDAV.Client.Exceptions.LockedException This folder or any child item is locked and no or invalid lock token was specified.

ITHit.WebDAV.Client.Exceptions.ForbiddenException User has not enough rights to perform this operation.

ITHit.WebDAV.Client.Exceptions.MethodNotAllowedException Trying to delete lock-null item. Lock-null items must be deleted using Unlock method.

ITHit.WebDAV.Client.Exceptions.WebDavHttpException Server returned unknown error.

ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.

function GetAllProperties

 Array GetAllProperties()

Retrieves all custom properties exposed by the item.

Returns:

List of Property objects.

Throws:

ITHit.WebDAV.Client.Exceptions.NotFoundException This item doesn't exist on the server.

ITHit.WebDAV.Client.Exceptions.WebDavHttpException Server returned unknown error.

ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.

function GetParent

 ITHit.WebDAV.Client.Folder GetParent()

Retrieves parent hierarchy item of this item.

Returns:

Parent hierarchy item of this item. Null for root item.

Throws:

ITHit.WebDAV.Client.Exceptions.NotFoundException This item doesn't exist on the server.

ITHit.WebDAV.Client.Exceptions.WebDavHttpException Server returned unknown error.

ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.

function GetPropertyNames

 Array GetPropertyNames()

Returns names of all custom properties exposed by this item.

Returns:

List of PropertyName objects.

Throws:

ITHit.WebDAV.Client.Exceptions.NotFoundException This item doesn't exist on the server.

ITHit.WebDAV.Client.Exceptions.WebDavHttpException Server returned unknown error.

ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.

function GetPropertyValues

Array GetPropertyValues(Array oNames)

Retrieves values of specific properties.

Parameters:

oNames Array of requested properties with values.

Returns:

List of Property objects.

Throws:

ITHit.WebDAV.Client.Exceptions.NotFoundException This item doesn't exist on the server.

ITHit.WebDAV.Client.Exceptions.PropertyForbiddenException User has not enough rights to obtain one of requested properties.

ITHit.WebDAV.Client.Exceptions.PropertyNotFoundException If one of requested properties was not found.

ITHit.WebDAV.Client.Exceptions.PropertyException Server returned unknown error for specific property.

ITHit.WebDAV.Client.Exceptions.WebDavHttpException Server returned unknown error.

ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.

function GetSource

 Array GetSource()

Retrieves media type independent links.

Returns:

Media type independent links or null.

Throws:

ITHit.WebDAV.Client.Exceptions.NotFoundException This item doesn't exist on the server.

ITHit.WebDAV.Client.Exceptions.PropertyNotFoundException If property is not supported.

ITHit.WebDAV.Client.Exceptions.PropertyException Server returned unknown error.

ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.

function GetUploadProgress

 ITHit.WebDAV.Client.UploadProgressInfo[] GetUploadProgress()

Get file upload progress. Works only with ITHit WebDAV DeltaV ReumableUpload Server.

Returns:

Array of upload progress info objects.

function Lock

ITHit.WebDAV.Client.LockInfo Lock(String sLockScope, Boolean bDeep, String sOwner, Integer iTimeout)

Locks the item.

Parameters:

sLockScope Scope of the lock.

bDeep Whether to lock entire subtree.

sOwner Owner of the lock.

iTimeout Timeout after which lock expires.

Returns:

Instance of LockInfo with information about created lock.

Throws:

ITHit.WebDAV.Client.Exceptions.PreconditionFailedException The included lock token was not enforceable on this resource or the server could not satisfy the request in the lockinfo XML element.

ITHit.WebDAV.Client.Exceptions.LockedException The resource is locked. The method has been rejected.

ITHit.WebDAV.Client.Exceptions.MethodNotAllowedException The item does not support locking.

ITHit.WebDAV.Client.Exceptions.NotFoundException The item doesn't exist on the server.

ITHit.WebDAV.Client.Exceptions.WebDavHttpException Server returned unknown error.

ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.

function MoveTo

  MoveTo(ITHit.WebDAV.Client.Folder oDestinationFolder, String sDestinationName, Boolean bOverwrite, [String sLockToken])

  MoveTo(ITHit.WebDAV.Client.Folder oDestinationFolder, String sDestinationName, Boolean bOverwrite, [ITHit.WebDAV.Client.LockUriTokenPair[] aLockTokens])

Moves this item to another location.

Parameters:

Syntax 1

oDestinationFolder Folder to move to.

sDestinationName Name to assign to moved item.

bOverwrite Whether existing destination item shall be overwritten.

sLockToken (optional) Lock token.

Syntax 2

oDestinationFolder Folder to move to.

sDestinationName Name to assign to moved item.

bOverwrite Whether existing destination item shall be overwritten.

aLockTokens (optional) Lock tokens for resources to be moved, for destination folder or resources to be overwritten that are locked.

Throws:

ITHit.WebDAV.Client.Exceptions.ForbiddenException The source and destination URIs are the same.

ITHit.WebDAV.Client.Exceptions.ConflictException A resource cannot be created at the destination until one or more intermediate collections have been created.

ITHit.WebDAV.Client.Exceptions.PreconditionFailedException The destination resource exists and overwrite was false.

ITHit.WebDAV.Client.Exceptions.LockedException The destination folder or items to be overwritten were locked or source items were locked.

ITHit.WebDAV.Client.Exceptions.NotFoundException This item doesn't exist on the server.

ITHit.WebDAV.Client.Exceptions.WebDavHttpException Server returned unknown error for specific resource.

ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.

function Refresh

  Refresh()

Refresh items's info.

Throws:

ITHit.WebDAV.Client.Exceptions.UnauthorizedException Incorrect credentials provided or insufficient permissions to access the requested item.

ITHit.WebDAV.Client.Exceptions.NotFoundException The requested folder doesn't exist on the server.

ITHit.WebDAV.Client.Exceptions.ForbiddenException The server refused to fulfill the request.

ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.

function RefreshLock

ITHit.WebDAV.Client.LockInfo RefreshLock(String sLockToken, Integer iTimeout)

Prolongs the lock.

Parameters:

sLockToken Identifies lock to be prolonged.

iTimeout New timeout to set.

Returns:

Instance of LockInfo with information about refreshed lock.

Throws:

ITHit.WebDAV.Client.Exceptions.PreconditionFailedException The included lock token was not enforceable on this resource or the server could not satisfy the request in the lockinfo XML element.

ITHit.WebDAV.Client.Exceptions.LockedException The resource is locked, so the method has been rejected.

ITHit.WebDAV.Client.Exceptions.NotFoundException This item doesn't exist on the server.

ITHit.WebDAV.Client.Exceptions.WebDavHttpException Server returned unknown error.

ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.

function SupportedFeatures

 ITHit.WebDAV.Client.OptionsInfo SupportedFeatures()

Gets the item type (Class 1 or Class 2).

Returns:

OptionsInfo object containing information about current server possibilities.

function Unlock

  Unlock()

Removes the lock.

Throws:

ITHit.WebDAV.Client.Exceptions.PreconditionFailedException The item is not locked.

ITHit.WebDAV.Client.Exceptions.MethodNotAllowedException The item does not support locking.

ITHit.WebDAV.Client.Exceptions.NotFoundException The item doesn't exist on the server.

ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.

function UpdateProperties

  UpdateProperties(ITHit.WebDAV.Client.Property[] oPropertiesToAddOrUpdate, ITHit.WebDAV.Client.PropertyName[] oPropertiesToDelete, String sLockToken)

Updates values of properties exposed by this item.

Parameters:

oPropertiesToAddOrUpdate Properties to be updated.

oPropertiesToDelete Names of properties to be removed from this item.

sLockToken Lock token.

Throws:

ITHit.WebDAV.Client.Exceptions.LockedException The item is locked and no or invalid lock token was provided.

ITHit.WebDAV.Client.Exceptions.PropertyForbiddenException Cannot alter one of the properties.

ITHit.WebDAV.Client.Exceptions.PropertyConflictException The client has provided a value whose semantics are not appropriate for the property. This includes trying to set read-only properties.

ITHit.WebDAV.Client.Exceptions.NotFoundException This item doesn't exist on the server.

ITHit.WebDAV.Client.Exceptions.PropertyException Server returned unknown error for specific property.

ITHit.WebDAV.Client.Exceptions.WebDavHttpException Server returned unknown error.

ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.