Class: File

File Class

Namespace

ITHit.WebDAV.Client

Represents a file on a WebDAV server.

Extends

Members

ActiveLocksArray.<ITHit.WebDAV.Client.LockInfo>

List of locks applied to this item.
Examples

AvailableBytesnumber

Number of bytes available for this user on server. -1 if server does not support Quota.

ContentLengthnumber

Length of the file.

ContentTypestring

Content type of the file.

CreationDateDate

The date item was created.

DisplayNamestring

User friendly item name.

Hrefstring

This item path on the server.

LastModifiedDate

Most recent modification date.
List of item properties.

ResourceTypestring

Type of the item (File or Folder).
See:
ResumableUpload instance to manage partially failed uploads.
Current WebDAV session.

SupportedLocksArray.<string>

Retrieves information about supported locks. Item can support exclusive, shared locks or do not support any locks. If you set exclusive lock other users will not be able to set any locks. If you set shared lock other users will be able to set shared lock on the item.
See:
Examples

UsedBytesnumber

Number of bytes used by this user on server. -1 if server does not support Quota.

VersionControlled

Returns true if file is under version control. Otherwise false. To detect if version control could be enabled for this item call GetSupportedFeaturesAsync and check for VersionControl token. To enable version control call PutUnderVersionControlAsync.

Methods

staticITHit.WebDAV.Client.File.GEdit(oRequest, sHref){ITHit.WebDAV.Client.GEditInfo}

Locks the item and upload to google drive.
Name Type Description
oRequest ITHit.WebDAV.Client.Request Current WebDAV session.
sHref string This item path on the server.
Returns:
ITHit.WebDAV.Client.GEditInfo Instance of GEditInfo.

staticITHit.WebDAV.Client.File.GEditAsync(oRequest, sHref, fCallback){ITHit.WebDAV.Client.Request}

Locks the item and upload to google drive.
Name Type Description
oRequest ITHit.WebDAV.Client.Request Current WebDAV session.
sHref string This item path on the server.
fCallback ITHit.WebDAV.Client.File~GEditAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.

staticITHit.WebDAV.Client.File.GUnlock(oRequest, sHref, sLockToken)

Removes the lock and update file.
Name Type Description
oRequest ITHit.WebDAV.Client.Request Current WebDAV session.
sHref string This item path on the server.
sLockToken string optional Identifies lock to be prolonged.
Throws:
  • ITHit.WebDAV.Client.Exceptions.PreconditionFailedException The item is not locked.
  • ITHit.WebDAV.Client.Exceptions.NotFoundException The item doesn't exist on the server.
  • ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.

staticITHit.WebDAV.Client.File.GUnlockAsync(oRequest, sHref, sLockToken, sRevisionID, fCallback){ITHit.WebDAV.Client.Request}

Removes the lock and update file.
Name Type Description
oRequest ITHit.WebDAV.Client.Request Current WebDAV session.
sHref string This item path on the server.
sLockToken string Identifies lock to be prolonged.
sRevisionID string Revision ID of google file.
fCallback ITHit.WebDAV.Client.File~GUnlockAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.

inherited CopyToAsync(oDestinationFolder, sDestinationName, bDeep, bOverwrite, oLockTokens, fCallback)

Copies this item to destination folder.
Name Type Description
oDestinationFolder ITHit.WebDAV.Client.Folder Folder to move to.
sDestinationName string Name to assign to copied item.
bDeep boolean Indicates whether children of this item should be copied.
bOverwrite boolean Whether existing destination item shall be overwritten.
oLockTokens Array.<ITHit.WebDAV.Client.LockUriTokenPair> optional Lock tokens for destination folder.
fCallback ITHit.WebDAV.Client.HierarchyItem~CopyToAsyncCallback Function to call when operation is completed.
Examples

inherited DeleteAsync(oLockTokens, fCallback){ITHit.WebDAV.Client.Request}

Deletes this item.
Name Type Description
oLockTokens ITHit.WebDAV.Client.LockUriTokenPair | null Lock tokens for this item or any locked child item.
fCallback ITHit.WebDAV.Client.HierarchyItem~DeleteAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

inherited GetAllPropertiesAsync(fCallback){ITHit.WebDAV.Client.Request}

Retrieves all custom properties exposed by the item.
Name Type Description
fCallback ITHit.WebDAV.Client.HierarchyItem~GetAllPropertiesAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

inherited GetParentAsync(aProperties, fCallback){ITHit.WebDAV.Client.Request}

Retrieves parent hierarchy item of this item.
Name Type Description
aProperties Array.<ITHit.WebDAV.Client.PropertyName> Additional properties requested from server. Default is empty array.
fCallback ITHit.WebDAV.Client.HierarchyItem~GetParentAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

inherited GetPropertyNamesAsync(fCallback){ITHit.WebDAV.Client.Request}

Returns names of all custom properties exposed by this item.
Name Type Description
fCallback ITHit.WebDAV.Client.HierarchyItem~GetPropertyNamesAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

inherited GetPropertyValuesAsync(aNames, fCallback){ITHit.WebDAV.Client.Request}

Retrieves values of specific properties.
Name Type Description
aNames Array.<ITHit.WebDAV.Client.PropertyName>
fCallback ITHit.WebDAV.Client.HierarchyItem~GetPropertyValuesAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

inherited GetSourceAsync(fCallback){ITHit.WebDAV.Client.Request}

Retrieves media type independent links.
Name Type Description
fCallback ITHit.WebDAV.Client.HierarchyItem~GetSourceAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.

inherited GetSupportedFeaturesAsync(fCallback){ITHit.WebDAV.Client.Request}

Gets features supported by this item, such as WebDAV class support.
Name Type Description
fCallback ITHit.WebDAV.Client.HierarchyItem~GetSupportedFeaturesAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

GetVersionsAsync(fCallback){ITHit.WebDAV.Client.Request}

Retrieves item versions.
Name Type Description
fCallback ITHit.WebDAV.Client.File~GetVersionsAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

inherited LockAsync(sLockScope, bDeep, sOwner, iTimeout, fCallback){ITHit.WebDAV.Client.Request}

Locks the item. If the lock was successfully applied, the server will return a lock token. You will pass this lock token back to the server when updating and unlocking the item. The actual lock time applied by the server may be different from the one requested by the client.
Name Type Description
sLockScope string Scope of the lock. See LockScope Enumeration ITHit.WebDAV.Client.LockScope
bDeep boolean Whether to lock entire subtree.
sOwner string Owner of the lock.
iTimeout number Timeout after which lock expires. Pass -1 to request an infinite timeout.
fCallback ITHit.WebDAV.Client.HierarchyItem~LockAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

inherited MoveToAsync(oDestinationFolder, sDestinationName, bOverwrite, oLockTokens, fCallback){ITHit.WebDAV.Client.Request}

Moves this item to another location.
Name Type Description
oDestinationFolder ITHit.WebDAV.Client.Folder Folder to move to.
sDestinationName string Name to assign to moved item.
bOverwrite boolean Whether existing destination item shall be overwritten.
oLockTokens string | Array.<ITHit.WebDAV.Client.LockUriTokenPair> Lock tokens for item to be moved, for destination folder or file to be overwritten that are locked.
fCallback ITHit.WebDAV.Client.HierarchyItem~MoveToAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

PutUnderVersionControlAsync(bEnable, mLockToken, fCallback){ITHit.WebDAV.Client.Request}

Enables / disables version control for this file.
Name Type Description
bEnable boolean True to enable version-control, false - to disable.
mLockToken string Lock token for this item.
fCallback ITHit.WebDAV.Client.File~PutUnderVersionControlAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

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

Reads 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

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

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.
Examples

inherited RefreshLockAsync(sLockToken, iTimeout, fCallback){ITHit.WebDAV.Client.Request}

Prolongs the lock.
Name Type Description
sLockToken string Identifies lock to be prolonged.
iTimeout number New timeout to set.
fCallback ITHit.WebDAV.Client.HierarchyItem~RefreshLockAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

inherited UnlockAsync(sLockToken, fCallback){ITHit.WebDAV.Client.Request}

Removes the lock.
Name Type Description
sLockToken string Identifies lock to be prolonged.
fCallback ITHit.WebDAV.Client.HierarchyItem~UnlockAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

inherited UpdatePropertiesAsync(oPropertiesToAddOrUpdate, oPropertiesToDelete, sLockToken, fCallback){ITHit.WebDAV.Client.WebDavRequest|null}

Updates values of properties exposed by this item.
Name Type Description
oPropertiesToAddOrUpdate Array.<ITHit.WebDAV.Client.Property> Properties to be updated.
oPropertiesToDelete Array.<ITHit.WebDAV.Client.PropertyName> Names of properties to be removed from this item.
sLockToken string optional Lock token.
fCallback ITHit.WebDAV.Client.HierarchyItem~UpdatePropertiesAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.WebDavRequest | null WebDAV request
Examples

UpdateToVersionAsync(mVersion, fCallback){ITHit.WebDAV.Client.Request}

Update to version.
Name Type Description
mVersion string | ITHit.WebDAV.Client.Version Href to file with version attribute or ITHit.WebDAV.Client.Version instance.
fCallback ITHit.WebDAV.Client.File~UpdateToVersionAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

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

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.
Examples

Type Definitions

GEditAsyncCallback(oResult)

Callback function to be called when item is locked on server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result ITHit.WebDAV.Client.GEditInfo Instance of GEditInfo.

GetVersionsAsyncCallback(oResult)

Callback function to be called when versions list loaded from server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result Array.<ITHit.WebDAV.Client.Version> List of Versions.

GUnlockAsyncCallback(oResult)

Callback function to be called when item unlocked on server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object

OpenAsyncCallback(oResult)

Callback function to be called when resource loaded from server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result ITHit.WebDAV.Client.File Loaded resource object.

PutUnderVersionControlAsyncCallback(oResult)

Callback function to be called when versioning is enabled or disabled.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object

ReadContentAsyncCallback(oResult)

Callback function to be called when file content loaded from server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result string Requested file content.

UpdateToVersionAsyncCallback(oResult)

Callback function to be called when version is updated on server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object

WriteContentAsyncCallback(oResult)

Callback function to be called when content saved in file on server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object