Class: Folder

Folder Class

Namespace

ITHit.WebDAV.Client

Represents a folder in a WebDAV repository.

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.

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:
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

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

CreateFileAsync(sName, sLockTokens, sContent, aProperties, fCallback){ITHit.WebDAV.Client.Request}

Creates a new file with a specified name as a child of this folder.
Name Type Description
sName string Name of the new file.
sLockTokens string Lock token for current folder.
sContent string File content.
aProperties Array.<ITHit.WebDAV.Client.PropertyName> Additional properties requested from server. Default is empty array.
fCallback ITHit.WebDAV.Client.Folder~CreateFileAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

CreateFolderAsync(sName, sLockTokens, aProperties, fCallback){ITHit.WebDAV.Client.Request}

Creates a new folder with a specified name as child of this folder.
Name Type Description
sName string Name of the new folder.
sLockTokens string optional Lock token for ITHit.WebDAV.Client.Folder folder.
aProperties Array.<ITHit.WebDAV.Client.PropertyName> Additional properties requested from server. Default is empty array.
fCallback ITHit.WebDAV.Client.Folder~CreateFolderAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
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

GetChildrenAsync(bRecursively, aProperties, fCallback){ITHit.WebDAV.Client.Request}

This method returns all items contained in the folder, which may be very large. To limit amount of items returned and get only a single results page use GetPageAsync function instead.
Name Type Description
bRecursively boolean Indicates if all subtree of children should be return. Default is false.
aProperties Array.<ITHit.WebDAV.Client.PropertyName> Additional properties requested from server. If null is specified, only default properties are returned.
fCallback ITHit.WebDAV.Client.Folder~GetChildrenAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

GetFileAsync(sName, fCallback){ITHit.WebDAV.Client.Request}

Gets the specified file from server.
Name Type Description
sName string Name of the file.
fCallback ITHit.WebDAV.Client.Folder~GetFileAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

GetFolderAsync(sName, fCallback){ITHit.WebDAV.Client.Request}

Gets the specified folder from server.
Name Type Description
sName string Name of the folder.
fCallback ITHit.WebDAV.Client.Folder~GetFolderAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.

GetItemAsync(sName, fCallback){ITHit.WebDAV.Client.Request}

Gets the specified item from server.
Name Type Description
sName string Name of the item.
fCallback ITHit.WebDAV.Client.Folder~GetItemAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.

GetPageAsync(aProperties, nOffset, nResults, aOrderProperties, fCallback){ITHit.WebDAV.Client.Request}

Gets specified number of children of this folder that correspond to requested offset and sorting. Use GetSupportedFeaturesAsync() function to detect if paging is supported.
Name Type Description
aProperties Array.<ITHit.WebDAV.Client.PropertyName> optional Additional properties requested from server. If null is specified, only default properties are returned.
nOffset number optional The number of items to skip before returning the remaining items.
nResults number optional The number of items to return.
aOrderProperties Array.<ITHit.WebDAV.Client.OrderProperty> optional List of order properties.
fCallback ITHit.WebDAV.Client.Folder~GetPageAsyncCallback 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

GetSearchPageAsync(sSearchQuery, aProperties, nOffset, nResults, fCallback){ITHit.WebDAV.Client.Request}

Searches folder by search string. Returns specified number of search result items that correspond to requested offset and sorting. Use GetSupportedFeaturesAsync() function to detect if paging is supported.
Name Type Description
sSearchQuery string String of search query.
aProperties Array.<ITHit.WebDAV.Client.PropertyName> optional Additional properties requested from server. If null is specified, only default properties are returned.
nOffset number optional The number of items to skip before returning the remaining items.
nResults number optional The number of items to return.
fCallback ITHit.WebDAV.Client.Folder~GetSearchPageAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

GetSearchPageByQueryAsync(oSearchQuery, nOffset, nResults, fCallback){ITHit.WebDAV.Client.Request}

Searches folder by query. Returns specified number of search result items that correspond to requested offset and sorting. Use GetSupportedFeaturesAsync() function to detect if paging is supported.
Name Type Description
oSearchQuery ITHit.WebDAV.Client.SearchQuery Object with search query conditions.
nOffset number optional The number of items to skip before returning the remaining items.
nResults number optional The number of items to return.
fCallback ITHit.WebDAV.Client.Folder~GetSearchPageByQueryAsyncCallback 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

ItemExistsAsync(sName, fCallback){ITHit.WebDAV.Client.Request}

Checks whether specified item exists in the folder.
Name Type Description
sName string Name of the item.
fCallback ITHit.WebDAV.Client.Folder~ItemExistsAsyncCallback 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

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

SearchAsync(sSearchQuery, aProperties, fCallback){ITHit.WebDAV.Client.Request}

Searches folder by search string. To limit amount of items returned and get only a single results page use GetSearchPageAsync function instead.
Name Type Description
sSearchQuery string String of search query.
aProperties Array.<ITHit.WebDAV.Client.PropertyName> optional Additional properties requested from server. If null is specified, only default properties are returned.
fCallback ITHit.WebDAV.Client.Folder~SearchAsyncCallback Function to call when operation is completed.
Returns:
ITHit.WebDAV.Client.Request Request object.
Examples

SearchByQueryAsync(oSearchQuery, fCallback){ITHit.WebDAV.Client.Request}

This method returns all items found on the server, which may be very large. To limit amount of items returned and get only a single results page use GetSearchPageByQueryAsync function instead.
Name Type Description
oSearchQuery ITHit.WebDAV.Client.SearchQuery Object with search query conditions.
fCallback ITHit.WebDAV.Client.Folder~SearchByQueryAsyncCallback 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

Type Definitions

CreateFileAsyncCallback(oResult)

Callback function to be called when a file is created on the server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result ITHit.WebDAV.Client.File Created file object.

CreateFolderAsyncCallback(oResult)

Callback function to be called when a folder is created on the server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result ITHit.WebDAV.Client.Folder Created folder object.

GetChildrenAsyncCallback(oResult)

Callback function to be called when children items loaded from server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result Array.<ITHit.WebDAV.Client.HierarchyItem> Array of file and folder objects.

GetFileAsyncCallback(oResult)

Callback function to be called when file loaded from server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result ITHit.WebDAV.Client.File File corresponding to requested path.

GetFolderAsyncCallback(oResult)

Callback function to be called when folder loaded from server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result ITHit.WebDAV.Client.Folder Folder object corresponding to requested path.

GetItemAsyncCallback(oResult)

Callback function to be called when item loaded from server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result ITHit.WebDAV.Client.HierarchyItem Item object corresponding to requested path.

GetPageAsyncCallback(oResult)

Callback function to be called when children items loaded from server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result ITHit.WebDAV.Client.PageResults sinle page results.

GetSearchPageAsyncCallback(oResult)

Callback function to be called when search is complete and items are loaded from server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result ITHit.WebDAV.Client.PageResults sinle page results.

GetSearchPageByQueryAsyncCallback(oResult)

Callback function to be called when search is complete and items are loaded from server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result ITHit.WebDAV.Client.PageResults sinle page results.

ItemExistsAsyncCallback(oResult)

Callback function to be called when check request is complete.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result boolean Returns true, if specified item exists; false, otherwise.

OpenItemAsyncCallback(oResult)

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

SearchAsyncCallback(oResult)

Callback function to be called when search is complete and items are loaded from server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object.
Name Type Description
Result Array.<ITHit.WebDAV.Client.HierarchyItem> Array of file objects.

SearchByQueryAsyncCallback(oResult)

Callback function to be called when search is complete and items are loaded from server.
Name Type Description
oResult ITHit.WebDAV.Client.AsyncResult Result object
Name Type Description
Result Array.<ITHit.WebDAV.Client.HierarchyItem> Array of file objects.