webdav.client 5.21.5846 → 5.21.5856
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Help/ClassReference/ITHit.WebDAV.Client.DocManager.html +7 -4
- package/Help/ClassReference/ITHit.WebDAV.Client.File.html +83 -80
- package/Help/ClassReference/ITHit.WebDAV.Client.Folder.html +103 -100
- package/Help/ClassReference/ITHit.WebDAV.Client.HierarchyItem.html +63 -60
- package/Help/ClassReference/ITHit.WebDAV.Client.MsOfficeEditExtensions.html +4 -4
- package/Help/ClassReference/ITHit.WebDAV.Client.Request.html +4 -4
- package/Help/ClassReference/ITHit.WebDAV.Client.Upload.Groups.GroupManager.html +111 -0
- package/Help/ClassReference/ITHit.WebDAV.Client.Upload.Settings.html +1 -1
- package/Help/ClassReference/ITHit.WebDAV.Client.Upload.UploaderSession.html +12 -12
- package/Help/ClassReference/ITHit.WebDAV.Client.Version.html +8 -8
- package/Help/ClassReference/ITHit.WebDAV.Client.WebDavSession.html +12 -12
- package/ITHitWebDAVClient.js +2 -2
- package/Plugins/ITHitEditDocumentOpener.deb +0 -0
- package/Plugins/ITHitEditDocumentOpener.msi +0 -0
- package/Plugins/ITHitEditDocumentOpener.pkg +0 -0
- package/Plugins/ITHitEditDocumentOpener.rpm +0 -0
- package/index.d.ts +1180 -125
- package/index.js +1 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// -----------------------------------------------------------------------
|
|
2
|
-
// IT Hit WebDAV Ajax Library v5.21.
|
|
2
|
+
// IT Hit WebDAV Ajax Library v5.21.5856.0
|
|
3
3
|
// Copyright © 2020 IT Hit LTD. All rights reserved.
|
|
4
4
|
// License: https://www.webdavsystem.com/ajax/
|
|
5
5
|
// -----------------------------------------------------------------------
|
|
@@ -56,7 +56,7 @@ export namespace ITHit{
|
|
|
56
56
|
* @api
|
|
57
57
|
* @param {ITHit.Logger~EventHandler} fHandler Handler function.
|
|
58
58
|
*/
|
|
59
|
-
function RemoveListener(fHandler?: () => void): void;
|
|
59
|
+
function RemoveListener(fHandler?: () => void | null): void;
|
|
60
60
|
/**
|
|
61
61
|
* Writs a message to log with a specified log level. Default log level is {@link ITHit.LogLevel#Info}
|
|
62
62
|
* @api
|
|
@@ -945,7 +945,7 @@ export namespace ITHit{
|
|
|
945
945
|
* @throws ITHit.Exception
|
|
946
946
|
*/
|
|
947
947
|
class Property {
|
|
948
|
-
constructor(sName: string | ITHit.WebDAV.Client.PropertyName, sValue?: string, sNamespace?: string);
|
|
948
|
+
constructor(sName: string | ITHit.WebDAV.Client.PropertyName, sValue?: string | null, sNamespace?: string | null);
|
|
949
949
|
/**
|
|
950
950
|
* Property Name.
|
|
951
951
|
* @api
|
|
@@ -1030,24 +1030,10 @@ export namespace ITHit{
|
|
|
1030
1030
|
* @enum {string}
|
|
1031
1031
|
* @class ITHit.WebDAV.Client.ResourceType
|
|
1032
1032
|
*/
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
* @readonly
|
|
1038
|
-
* @type {string}
|
|
1039
|
-
*/
|
|
1040
|
-
static readonly Folder: string
|
|
1041
|
-
readonly Folder: string
|
|
1042
|
-
/**
|
|
1043
|
-
* Item is file.
|
|
1044
|
-
* @api
|
|
1045
|
-
* @readonly
|
|
1046
|
-
* @type {string}
|
|
1047
|
-
*/
|
|
1048
|
-
static readonly File: string
|
|
1049
|
-
readonly File: string
|
|
1050
|
-
}/**
|
|
1033
|
+
enum ResourceType{
|
|
1034
|
+
Folder = "Folder",
|
|
1035
|
+
File = "Resource",
|
|
1036
|
+
}/**
|
|
1051
1037
|
* List of WebDAV properties.
|
|
1052
1038
|
* @api
|
|
1053
1039
|
* @class ITHit.WebDAV.Client.PropertyList
|
|
@@ -1062,7 +1048,7 @@ export namespace ITHit{
|
|
|
1062
1048
|
* @param {boolean} [bIgnoreCase] Specifies if the search is case sensitive or case insensitive.
|
|
1063
1049
|
* @returns {boolean}
|
|
1064
1050
|
*/
|
|
1065
|
-
Has(oPropName: ITHit.WebDAV.Client.PropertyName, bIgnoreCase?: boolean): boolean;
|
|
1051
|
+
Has(oPropName: ITHit.WebDAV.Client.PropertyName, bIgnoreCase?: boolean | null): boolean;
|
|
1066
1052
|
/**
|
|
1067
1053
|
* Gets property value found by property name and namespace. Returns null if property with such name does not exist.
|
|
1068
1054
|
* @api
|
|
@@ -1070,7 +1056,7 @@ export namespace ITHit{
|
|
|
1070
1056
|
* @param {boolean} [bIgnoreCase] Specifies if the search is case sensitive or case insensitive.
|
|
1071
1057
|
* @returns {(string|null)} String representing property value or null if property with such name does not exist.
|
|
1072
1058
|
*/
|
|
1073
|
-
Find(oPropName: ITHit.WebDAV.Client.PropertyName, bIgnoreCase?: boolean): string | null;
|
|
1059
|
+
Find(oPropName: ITHit.WebDAV.Client.PropertyName, bIgnoreCase?: boolean | null): string | null;
|
|
1074
1060
|
}/**
|
|
1075
1061
|
* Represents information about errors occurred in different elements.
|
|
1076
1062
|
* @api
|
|
@@ -1151,22 +1137,10 @@ export namespace ITHit{
|
|
|
1151
1137
|
* @enum {string}
|
|
1152
1138
|
* @class ITHit.WebDAV.Client.LockScope
|
|
1153
1139
|
*/
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1158
|
-
* @type {string}
|
|
1159
|
-
*/
|
|
1160
|
-
static Exclusive: string
|
|
1161
|
-
Exclusive: string
|
|
1162
|
-
/**
|
|
1163
|
-
* Shared lock. It will be possible for another clients to get the shared locks.
|
|
1164
|
-
* @api
|
|
1165
|
-
* @type {string}
|
|
1166
|
-
*/
|
|
1167
|
-
static Shared: string
|
|
1168
|
-
Shared: string
|
|
1169
|
-
}/**
|
|
1140
|
+
enum LockScope{
|
|
1141
|
+
Exclusive = "Exclusive",
|
|
1142
|
+
Shared = "Shared",
|
|
1143
|
+
}/**
|
|
1170
1144
|
* Represents pair of resource uri - lock token. Is used to access locked resources.
|
|
1171
1145
|
* @api
|
|
1172
1146
|
* @class ITHit.WebDAV.Client.LockUriTokenPair
|
|
@@ -1432,7 +1406,7 @@ export namespace ITHit{
|
|
|
1432
1406
|
* @param {ITHit.WebDAV.Client.HierarchyItem~RefreshAsyncCallback} fCallback Function to call when operation is completed.
|
|
1433
1407
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1434
1408
|
*/
|
|
1435
|
-
RefreshAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1409
|
+
RefreshAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1436
1410
|
/**
|
|
1437
1411
|
* Copies this item to destination folder.
|
|
1438
1412
|
* @api
|
|
@@ -1445,17 +1419,17 @@ export namespace ITHit{
|
|
|
1445
1419
|
* @param {ITHit.WebDAV.Client.LockUriTokenPair[]} [oLockTokens] Lock tokens for destination folder.
|
|
1446
1420
|
* @param {ITHit.WebDAV.Client.HierarchyItem~CopyToAsyncCallback} fCallback Function to call when operation is completed.
|
|
1447
1421
|
*/
|
|
1448
|
-
CopyToAsync(oDestinationFolder: ITHit.WebDAV.Client.Folder, sDestinationName: string, bDeep: boolean, bOverwrite: boolean, oLockTokens?: ITHit.WebDAV.Client.LockUriTokenPair[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): void;
|
|
1422
|
+
CopyToAsync(oDestinationFolder: ITHit.WebDAV.Client.Folder, sDestinationName: string, bDeep: boolean, bOverwrite: boolean, oLockTokens?: ITHit.WebDAV.Client.LockUriTokenPair[] | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
|
|
1449
1423
|
/**
|
|
1450
1424
|
* Deletes this item.
|
|
1451
1425
|
* @api
|
|
1452
1426
|
* @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Delete.Delete
|
|
1453
1427
|
* @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Delete.Delete
|
|
1454
|
-
* @param {ITHit.WebDAV.Client.LockUriTokenPair} oLockTokens Lock tokens for this item or any locked child item.
|
|
1428
|
+
* @param {ITHit.WebDAV.Client.LockUriTokenPair | null} oLockTokens Lock tokens for this item or any locked child item.
|
|
1455
1429
|
* @param {ITHit.WebDAV.Client.HierarchyItem~DeleteAsyncCallback} fCallback Function to call when operation is completed.
|
|
1456
1430
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1457
1431
|
*/
|
|
1458
|
-
DeleteAsync(oLockTokens: ITHit.WebDAV.Client.LockUriTokenPair, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1432
|
+
DeleteAsync(oLockTokens: ITHit.WebDAV.Client.LockUriTokenPair | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1459
1433
|
/**
|
|
1460
1434
|
* Returns names of all custom properties exposed by this item.
|
|
1461
1435
|
* @api
|
|
@@ -1464,7 +1438,7 @@ export namespace ITHit{
|
|
|
1464
1438
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetPropertyNamesAsyncCallback} fCallback Function to call when operation is completed.
|
|
1465
1439
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1466
1440
|
*/
|
|
1467
|
-
GetPropertyNamesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1441
|
+
GetPropertyNamesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1468
1442
|
/**
|
|
1469
1443
|
* Retrieves values of specific properties.
|
|
1470
1444
|
* @api
|
|
@@ -1474,7 +1448,7 @@ export namespace ITHit{
|
|
|
1474
1448
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetPropertyValuesAsyncCallback} fCallback Function to call when operation is completed.
|
|
1475
1449
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1476
1450
|
*/
|
|
1477
|
-
GetPropertyValuesAsync(aNames: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1451
|
+
GetPropertyValuesAsync(aNames: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1478
1452
|
/**
|
|
1479
1453
|
* Retrieves all custom properties exposed by the item.
|
|
1480
1454
|
* @api
|
|
@@ -1483,7 +1457,7 @@ export namespace ITHit{
|
|
|
1483
1457
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetAllPropertiesAsyncCallback} fCallback Function to call when operation is completed.
|
|
1484
1458
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1485
1459
|
*/
|
|
1486
|
-
GetAllPropertiesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1460
|
+
GetAllPropertiesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1487
1461
|
/**
|
|
1488
1462
|
* Retrieves parent hierarchy item of this item.
|
|
1489
1463
|
* @api
|
|
@@ -1493,14 +1467,14 @@ export namespace ITHit{
|
|
|
1493
1467
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetParentAsyncCallback} fCallback Function to call when operation is completed.
|
|
1494
1468
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1495
1469
|
*/
|
|
1496
|
-
GetParentAsync(aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1470
|
+
GetParentAsync(aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1497
1471
|
/**
|
|
1498
1472
|
* Retrieves media type independent links.
|
|
1499
1473
|
* @api
|
|
1500
1474
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetSourceAsyncCallback} fCallback Function to call when operation is completed.
|
|
1501
1475
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1502
1476
|
*/
|
|
1503
|
-
GetSourceAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1477
|
+
GetSourceAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1504
1478
|
/**
|
|
1505
1479
|
* Locks the item. If the lock was successfully applied, the server will return a lock token. You will pass this
|
|
1506
1480
|
* lock token back to the server when updating and unlocking the item. The actual lock time applied by the server
|
|
@@ -1515,7 +1489,7 @@ export namespace ITHit{
|
|
|
1515
1489
|
* @param {ITHit.WebDAV.Client.HierarchyItem~LockAsyncCallback} fCallback Function to call when operation is completed.
|
|
1516
1490
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1517
1491
|
*/
|
|
1518
|
-
LockAsync(sLockScope: string, bDeep: boolean, sOwner: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1492
|
+
LockAsync(sLockScope: string, bDeep: boolean, sOwner: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1519
1493
|
/**
|
|
1520
1494
|
* Moves this item to another location.
|
|
1521
1495
|
* @api
|
|
@@ -1528,7 +1502,7 @@ export namespace ITHit{
|
|
|
1528
1502
|
* @param {ITHit.WebDAV.Client.HierarchyItem~MoveToAsyncCallback} fCallback Function to call when operation is completed.
|
|
1529
1503
|
* @return {ITHit.WebDAV.Client.Request} Request object.
|
|
1530
1504
|
*/
|
|
1531
|
-
MoveToAsync(oDestinationFolder: ITHit.WebDAV.Client.Folder, sDestinationName: string, bOverwrite: boolean, oLockTokens: string | ITHit.WebDAV.Client.LockUriTokenPair[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1505
|
+
MoveToAsync(oDestinationFolder: ITHit.WebDAV.Client.Folder, sDestinationName: string, bOverwrite: boolean, oLockTokens: string | ITHit.WebDAV.Client.LockUriTokenPair[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1532
1506
|
/**
|
|
1533
1507
|
* Prolongs the lock.
|
|
1534
1508
|
* @api
|
|
@@ -1539,7 +1513,7 @@ export namespace ITHit{
|
|
|
1539
1513
|
* @param {ITHit.WebDAV.Client.HierarchyItem~RefreshLockAsyncCallback} fCallback Function to call when operation is completed.
|
|
1540
1514
|
* @return {ITHit.WebDAV.Client.Request} Request object.
|
|
1541
1515
|
*/
|
|
1542
|
-
RefreshLockAsync(sLockToken: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1516
|
+
RefreshLockAsync(sLockToken: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1543
1517
|
/**
|
|
1544
1518
|
* Gets features supported by this item, such as WebDAV class support.
|
|
1545
1519
|
* @api
|
|
@@ -1548,7 +1522,7 @@ export namespace ITHit{
|
|
|
1548
1522
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetSupportedFeaturesAsyncCallback} fCallback Function to call when operation is completed.
|
|
1549
1523
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1550
1524
|
*/
|
|
1551
|
-
GetSupportedFeaturesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1525
|
+
GetSupportedFeaturesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1552
1526
|
/**
|
|
1553
1527
|
* Removes the lock.
|
|
1554
1528
|
* @api
|
|
@@ -1558,7 +1532,7 @@ export namespace ITHit{
|
|
|
1558
1532
|
* @param {ITHit.WebDAV.Client.HierarchyItem~UnlockAsyncCallback} fCallback Function to call when operation is completed.
|
|
1559
1533
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1560
1534
|
*/
|
|
1561
|
-
UnlockAsync(sLockToken: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1535
|
+
UnlockAsync(sLockToken: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1562
1536
|
/**
|
|
1563
1537
|
* Updates values of properties exposed by this item.
|
|
1564
1538
|
* @api
|
|
@@ -1572,7 +1546,7 @@ export namespace ITHit{
|
|
|
1572
1546
|
* @param {ITHit.WebDAV.Client.HierarchyItem~UpdatePropertiesAsyncCallback} fCallback Function to call when operation is completed.
|
|
1573
1547
|
* @returns {ITHit.WebDAV.Client.WebDavRequest|null} WebDAV request
|
|
1574
1548
|
*/
|
|
1575
|
-
UpdatePropertiesAsync(oPropertiesToAddOrUpdate: ITHit.WebDAV.Client.Property[], oPropertiesToDelete: ITHit.WebDAV.Client.PropertyName[], sLockToken?: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.WebDavRequest | null;
|
|
1549
|
+
UpdatePropertiesAsync(oPropertiesToAddOrUpdate: ITHit.WebDAV.Client.Property[], oPropertiesToDelete: ITHit.WebDAV.Client.PropertyName[], sLockToken?: string | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.WebDavRequest | null;
|
|
1576
1550
|
}/**
|
|
1577
1551
|
* The class represents set of extensions to be edited with Microsoft Office.
|
|
1578
1552
|
* @api
|
|
@@ -1679,7 +1653,7 @@ export namespace ITHit{
|
|
|
1679
1653
|
* @param {string} [sCookieNames] <span class="optional">v3 Beta and later only.</span> Coma separated list of cookie names to search for. Microsoft Office requires persistent cookie (with expiration date), it does not support session cookies.
|
|
1680
1654
|
* @param {string} [sLoginUrl] <span class="optional">v3 Beta and later only.</span> Login URL to redirect to in case any cookies specified in <code>sCookieNames</code> parameter are not found.
|
|
1681
1655
|
*/
|
|
1682
|
-
function OpenFolderInOsFileManager(sFolderUrl: string, sMountUrl?: string, errorCallback?: Function, reserved?: string, sSearchIn?: string, sCookieNames?: string, sLoginUrl?: string): void;
|
|
1656
|
+
function OpenFolderInOsFileManager(sFolderUrl: string, sMountUrl?: string | null, errorCallback?: Function | null, reserved?: string | null, sSearchIn?: string | null, sCookieNames?: string | null, sLoginUrl?: string | null): void;
|
|
1683
1657
|
/**
|
|
1684
1658
|
* Extracts extension and returns true if URL points to Microsoft Office Document.
|
|
1685
1659
|
* @api
|
|
@@ -1730,7 +1704,7 @@ export namespace ITHit{
|
|
|
1730
1704
|
* @param {function} [errorCallback] Function to call if document opening failed. Typically you will request the protocol installation in this callback. This callback is executed for non-Microsoft Office documents only.
|
|
1731
1705
|
* If not specified a default message offering protocol installation will be displayed.
|
|
1732
1706
|
*/
|
|
1733
|
-
function EditDocument(sDocumentUrl: string, sMountUrl?: string, errorCallback?: Function): void;
|
|
1707
|
+
function EditDocument(sDocumentUrl: string, sMountUrl?: string | null, errorCallback?: Function | null): void;
|
|
1734
1708
|
/**
|
|
1735
1709
|
* Extracts extension and returns true if the document can be edited in G Suite editor or document preview generated via G Suite.
|
|
1736
1710
|
* @api
|
|
@@ -1745,7 +1719,7 @@ export namespace ITHit{
|
|
|
1745
1719
|
* @param {DOM} oContainerDomElement HTML DOM element where the G Suite online editor will be loaded. If this parameter is omitted or null is passed the editor will be created in a new tab/window.
|
|
1746
1720
|
* @param {function} [errorCallback] Function to call if document opening failed.
|
|
1747
1721
|
*/
|
|
1748
|
-
function GSuiteEditDocument(sDocumentUrl: string, oContainerDomElement: any, errorCallback?: Function): void;
|
|
1722
|
+
function GSuiteEditDocument(sDocumentUrl: string, oContainerDomElement: any, errorCallback?: Function | null): void;
|
|
1749
1723
|
/**
|
|
1750
1724
|
* <p>Preview MS Office document with G Suite Online Tool.</p>
|
|
1751
1725
|
* @api
|
|
@@ -1753,7 +1727,7 @@ export namespace ITHit{
|
|
|
1753
1727
|
* @param {DOM} oContainerDomElement HTML DOM element where the G Suite preview will be loaded. If this parameter is omitted or null is passed the preview will be created in a new tab/window.
|
|
1754
1728
|
* @param {function} [errorCallback] Function to call if document opening failed.
|
|
1755
1729
|
*/
|
|
1756
|
-
function GSuitePreviewDocument(sDocumentUrl: string, oContainerDomElement: any, errorCallback?: Function): void;
|
|
1730
|
+
function GSuitePreviewDocument(sDocumentUrl: string, oContainerDomElement: any, errorCallback?: Function | null): void;
|
|
1757
1731
|
/**
|
|
1758
1732
|
* <p>Opens document for editing or printing using davX: protocol and prompts to install the protocol it if not found.</p>
|
|
1759
1733
|
* <i class="optional">The following functionality is supported in v3 Beta and later only:</i>
|
|
@@ -1795,7 +1769,7 @@ export namespace ITHit{
|
|
|
1795
1769
|
* </body>
|
|
1796
1770
|
* </html>
|
|
1797
1771
|
* @api
|
|
1798
|
-
* @param {string} sDocumentUrls Array of document URLs to be opened for editing from server. All documents must be located under the same mount URL (specified in <code>sMountUrl</code> parameter). Must be a full URL(s) including the domain name.
|
|
1772
|
+
* @param {string | string[]} sDocumentUrls Array of document URLs to be opened for editing from server. All documents must be located under the same mount URL (specified in <code>sMountUrl</code> parameter). Must be a full URL(s) including the domain name.
|
|
1799
1773
|
* @param {string} [sMountUrl] URL to mount file system to before opening the folder. Usually this is your WebDAV server root folder. If this perameter is not specified file system will be mounted to the folder in which document is located.
|
|
1800
1774
|
* @param {function} [errorCallback] Function to call if document opening failed. Typically you will request the protocol installation in this callback.
|
|
1801
1775
|
* If not specified a default message offering protocol installation will be displayed.
|
|
@@ -1818,7 +1792,7 @@ export namespace ITHit{
|
|
|
1818
1792
|
* </ul>
|
|
1819
1793
|
* Default is <code>null</code>.
|
|
1820
1794
|
*/
|
|
1821
|
-
function DavProtocolEditDocument(sDocumentUrls: string, sMountUrl?: string, errorCallback?: Function, reserved?: string, sSearchIn?: string, sCookieNames?: string, sLoginUrl?: string, sCommand?: string): void;
|
|
1795
|
+
function DavProtocolEditDocument(sDocumentUrls: string | string[], sMountUrl?: string | null, errorCallback?: Function | null, reserved?: string | null, sSearchIn?: string | null, sCookieNames?: string | null, sLoginUrl?: string | null, sCommand?: string | null): void;
|
|
1822
1796
|
}class DocManager {
|
|
1823
1797
|
/**
|
|
1824
1798
|
* Collection of extensions of files which are opened with Microsoft Office.
|
|
@@ -1851,7 +1825,7 @@ export namespace ITHit{
|
|
|
1851
1825
|
* @param {ITHit.WebDAV.Client.ResumableUpload~GetBytesUploadedAsyncCallback} fCallback Function to call when operation is completed.
|
|
1852
1826
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1853
1827
|
*/
|
|
1854
|
-
GetBytesUploadedAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1828
|
+
GetBytesUploadedAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1855
1829
|
/**
|
|
1856
1830
|
* Cancels upload of the file.
|
|
1857
1831
|
* @api
|
|
@@ -1859,7 +1833,7 @@ export namespace ITHit{
|
|
|
1859
1833
|
* @param {ITHit.WebDAV.Client.ResumableUpload~CancelUploadAsyncCallback} fCallback Function to call when operation is completed.
|
|
1860
1834
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1861
1835
|
*/
|
|
1862
|
-
CancelUploadAsync(mLockTokens: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1836
|
+
CancelUploadAsync(mLockTokens: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1863
1837
|
}/**
|
|
1864
1838
|
* Information about lock set on an item.
|
|
1865
1839
|
* @api
|
|
@@ -1901,7 +1875,7 @@ export namespace ITHit{
|
|
|
1901
1875
|
* @param {ITHit.WebDAV.Client.File~GEditAsyncCallback} fCallback Function to call when operation is completed.
|
|
1902
1876
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1903
1877
|
*/
|
|
1904
|
-
function GEditAsync(oRequest: ITHit.WebDAV.Client.Request, sHref: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1878
|
+
function GEditAsync(oRequest: ITHit.WebDAV.Client.Request, sHref: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1905
1879
|
/**
|
|
1906
1880
|
* Removes the lock and update file.
|
|
1907
1881
|
* @api
|
|
@@ -1912,7 +1886,7 @@ export namespace ITHit{
|
|
|
1912
1886
|
* @throws ITHit.WebDAV.Client.Exceptions.NotFoundException The item doesn't exist on the server.
|
|
1913
1887
|
* @throws ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.
|
|
1914
1888
|
*/
|
|
1915
|
-
function GUnlock(oRequest: ITHit.WebDAV.Client.Request, sHref: string, sLockToken?: string): void;
|
|
1889
|
+
function GUnlock(oRequest: ITHit.WebDAV.Client.Request, sHref: string, sLockToken?: string | null): void;
|
|
1916
1890
|
/**
|
|
1917
1891
|
* Removes the lock and update file.
|
|
1918
1892
|
* @api
|
|
@@ -1923,7 +1897,7 @@ export namespace ITHit{
|
|
|
1923
1897
|
* @param {ITHit.WebDAV.Client.File~GUnlockAsyncCallback} fCallback Function to call when operation is completed.
|
|
1924
1898
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1925
1899
|
*/
|
|
1926
|
-
function GUnlockAsync(oRequest: ITHit.WebDAV.Client.Request, sHref: string, sLockToken: string, sRevisionID: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1900
|
+
function GUnlockAsync(oRequest: ITHit.WebDAV.Client.Request, sHref: string, sLockToken: string, sRevisionID: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1927
1901
|
}class File extends ITHit.WebDAV.Client.HierarchyItem {
|
|
1928
1902
|
/**
|
|
1929
1903
|
* Length of the file.
|
|
@@ -1957,7 +1931,7 @@ export namespace ITHit{
|
|
|
1957
1931
|
* @param {ITHit.WebDAV.Client.File~ReadContentAsyncCallback} fCallback Function to call when operation is completed.
|
|
1958
1932
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1959
1933
|
*/
|
|
1960
|
-
ReadContentAsync(iBytesFrom: number, iBytesCount: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1934
|
+
ReadContentAsync(iBytesFrom: number, iBytesCount: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1961
1935
|
/**
|
|
1962
1936
|
* Writes file content.
|
|
1963
1937
|
* @api
|
|
@@ -1969,7 +1943,7 @@ export namespace ITHit{
|
|
|
1969
1943
|
* @param {ITHit.WebDAV.Client.File~WriteContentAsyncCallback} fCallback Function to call when operation is completed.
|
|
1970
1944
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1971
1945
|
*/
|
|
1972
|
-
WriteContentAsync(sContent: string, sLockToken: string, sMimeType: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1946
|
+
WriteContentAsync(sContent: string, sLockToken: string, sMimeType: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1973
1947
|
/**
|
|
1974
1948
|
* Retrieves item versions.
|
|
1975
1949
|
* @examplecode ITHit.WebDAV.Client.Tests.Versions.GetVersions.GetVersions
|
|
@@ -1978,7 +1952,7 @@ export namespace ITHit{
|
|
|
1978
1952
|
* @param {ITHit.WebDAV.Client.File~GetVersionsAsyncCallback} fCallback Function to call when operation is completed.
|
|
1979
1953
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1980
1954
|
*/
|
|
1981
|
-
GetVersionsAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1955
|
+
GetVersionsAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1982
1956
|
/**
|
|
1983
1957
|
* Update to version.
|
|
1984
1958
|
* @examplecode ITHit.WebDAV.Client.Tests.Versions.ManageVersions.UpdateToVersion
|
|
@@ -1988,7 +1962,7 @@ export namespace ITHit{
|
|
|
1988
1962
|
* @param {ITHit.WebDAV.Client.File~UpdateToVersionAsyncCallback} fCallback Function to call when operation is completed.
|
|
1989
1963
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
1990
1964
|
*/
|
|
1991
|
-
UpdateToVersionAsync(mVersion: string | ITHit.WebDAV.Client.Version, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1965
|
+
UpdateToVersionAsync(mVersion: string | ITHit.WebDAV.Client.Version, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
1992
1966
|
/**
|
|
1993
1967
|
* Enables / disables version control for this file.
|
|
1994
1968
|
* @api
|
|
@@ -1999,7 +1973,7 @@ export namespace ITHit{
|
|
|
1999
1973
|
* @param {ITHit.WebDAV.Client.File~PutUnderVersionControlAsyncCallback} fCallback Function to call when operation is completed.
|
|
2000
1974
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2001
1975
|
*/
|
|
2002
|
-
PutUnderVersionControlAsync(bEnable: boolean, mLockToken: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
1976
|
+
PutUnderVersionControlAsync(bEnable: boolean, mLockToken: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2003
1977
|
/**
|
|
2004
1978
|
* Current WebDAV session.
|
|
2005
1979
|
* @api
|
|
@@ -2089,7 +2063,7 @@ export namespace ITHit{
|
|
|
2089
2063
|
* @param {ITHit.WebDAV.Client.HierarchyItem~RefreshAsyncCallback} fCallback Function to call when operation is completed.
|
|
2090
2064
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2091
2065
|
*/
|
|
2092
|
-
RefreshAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2066
|
+
RefreshAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2093
2067
|
/**
|
|
2094
2068
|
* Copies this item to destination folder.
|
|
2095
2069
|
* @api
|
|
@@ -2102,17 +2076,17 @@ export namespace ITHit{
|
|
|
2102
2076
|
* @param {ITHit.WebDAV.Client.LockUriTokenPair[]} [oLockTokens] Lock tokens for destination folder.
|
|
2103
2077
|
* @param {ITHit.WebDAV.Client.HierarchyItem~CopyToAsyncCallback} fCallback Function to call when operation is completed.
|
|
2104
2078
|
*/
|
|
2105
|
-
CopyToAsync(oDestinationFolder: ITHit.WebDAV.Client.Folder, sDestinationName: string, bDeep: boolean, bOverwrite: boolean, oLockTokens?: ITHit.WebDAV.Client.LockUriTokenPair[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): void;
|
|
2079
|
+
CopyToAsync(oDestinationFolder: ITHit.WebDAV.Client.Folder, sDestinationName: string, bDeep: boolean, bOverwrite: boolean, oLockTokens?: ITHit.WebDAV.Client.LockUriTokenPair[] | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
|
|
2106
2080
|
/**
|
|
2107
2081
|
* Deletes this item.
|
|
2108
2082
|
* @api
|
|
2109
2083
|
* @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Delete.Delete
|
|
2110
2084
|
* @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Delete.Delete
|
|
2111
|
-
* @param {ITHit.WebDAV.Client.LockUriTokenPair} oLockTokens Lock tokens for this item or any locked child item.
|
|
2085
|
+
* @param {ITHit.WebDAV.Client.LockUriTokenPair | null} oLockTokens Lock tokens for this item or any locked child item.
|
|
2112
2086
|
* @param {ITHit.WebDAV.Client.HierarchyItem~DeleteAsyncCallback} fCallback Function to call when operation is completed.
|
|
2113
2087
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2114
2088
|
*/
|
|
2115
|
-
DeleteAsync(oLockTokens: ITHit.WebDAV.Client.LockUriTokenPair, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2089
|
+
DeleteAsync(oLockTokens: ITHit.WebDAV.Client.LockUriTokenPair | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2116
2090
|
/**
|
|
2117
2091
|
* Returns names of all custom properties exposed by this item.
|
|
2118
2092
|
* @api
|
|
@@ -2121,7 +2095,7 @@ export namespace ITHit{
|
|
|
2121
2095
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetPropertyNamesAsyncCallback} fCallback Function to call when operation is completed.
|
|
2122
2096
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2123
2097
|
*/
|
|
2124
|
-
GetPropertyNamesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2098
|
+
GetPropertyNamesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2125
2099
|
/**
|
|
2126
2100
|
* Retrieves values of specific properties.
|
|
2127
2101
|
* @api
|
|
@@ -2131,7 +2105,7 @@ export namespace ITHit{
|
|
|
2131
2105
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetPropertyValuesAsyncCallback} fCallback Function to call when operation is completed.
|
|
2132
2106
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2133
2107
|
*/
|
|
2134
|
-
GetPropertyValuesAsync(aNames: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2108
|
+
GetPropertyValuesAsync(aNames: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2135
2109
|
/**
|
|
2136
2110
|
* Retrieves all custom properties exposed by the item.
|
|
2137
2111
|
* @api
|
|
@@ -2140,7 +2114,7 @@ export namespace ITHit{
|
|
|
2140
2114
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetAllPropertiesAsyncCallback} fCallback Function to call when operation is completed.
|
|
2141
2115
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2142
2116
|
*/
|
|
2143
|
-
GetAllPropertiesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2117
|
+
GetAllPropertiesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2144
2118
|
/**
|
|
2145
2119
|
* Retrieves parent hierarchy item of this item.
|
|
2146
2120
|
* @api
|
|
@@ -2150,14 +2124,14 @@ export namespace ITHit{
|
|
|
2150
2124
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetParentAsyncCallback} fCallback Function to call when operation is completed.
|
|
2151
2125
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2152
2126
|
*/
|
|
2153
|
-
GetParentAsync(aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2127
|
+
GetParentAsync(aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2154
2128
|
/**
|
|
2155
2129
|
* Retrieves media type independent links.
|
|
2156
2130
|
* @api
|
|
2157
2131
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetSourceAsyncCallback} fCallback Function to call when operation is completed.
|
|
2158
2132
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2159
2133
|
*/
|
|
2160
|
-
GetSourceAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2134
|
+
GetSourceAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2161
2135
|
/**
|
|
2162
2136
|
* Locks the item. If the lock was successfully applied, the server will return a lock token. You will pass this
|
|
2163
2137
|
* lock token back to the server when updating and unlocking the item. The actual lock time applied by the server
|
|
@@ -2172,7 +2146,7 @@ export namespace ITHit{
|
|
|
2172
2146
|
* @param {ITHit.WebDAV.Client.HierarchyItem~LockAsyncCallback} fCallback Function to call when operation is completed.
|
|
2173
2147
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2174
2148
|
*/
|
|
2175
|
-
LockAsync(sLockScope: string, bDeep: boolean, sOwner: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2149
|
+
LockAsync(sLockScope: string, bDeep: boolean, sOwner: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2176
2150
|
/**
|
|
2177
2151
|
* Moves this item to another location.
|
|
2178
2152
|
* @api
|
|
@@ -2185,7 +2159,7 @@ export namespace ITHit{
|
|
|
2185
2159
|
* @param {ITHit.WebDAV.Client.HierarchyItem~MoveToAsyncCallback} fCallback Function to call when operation is completed.
|
|
2186
2160
|
* @return {ITHit.WebDAV.Client.Request} Request object.
|
|
2187
2161
|
*/
|
|
2188
|
-
MoveToAsync(oDestinationFolder: ITHit.WebDAV.Client.Folder, sDestinationName: string, bOverwrite: boolean, oLockTokens: string | ITHit.WebDAV.Client.LockUriTokenPair[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2162
|
+
MoveToAsync(oDestinationFolder: ITHit.WebDAV.Client.Folder, sDestinationName: string, bOverwrite: boolean, oLockTokens: string | ITHit.WebDAV.Client.LockUriTokenPair[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2189
2163
|
/**
|
|
2190
2164
|
* Prolongs the lock.
|
|
2191
2165
|
* @api
|
|
@@ -2196,7 +2170,7 @@ export namespace ITHit{
|
|
|
2196
2170
|
* @param {ITHit.WebDAV.Client.HierarchyItem~RefreshLockAsyncCallback} fCallback Function to call when operation is completed.
|
|
2197
2171
|
* @return {ITHit.WebDAV.Client.Request} Request object.
|
|
2198
2172
|
*/
|
|
2199
|
-
RefreshLockAsync(sLockToken: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2173
|
+
RefreshLockAsync(sLockToken: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2200
2174
|
/**
|
|
2201
2175
|
* Gets features supported by this item, such as WebDAV class support.
|
|
2202
2176
|
* @api
|
|
@@ -2205,7 +2179,7 @@ export namespace ITHit{
|
|
|
2205
2179
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetSupportedFeaturesAsyncCallback} fCallback Function to call when operation is completed.
|
|
2206
2180
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2207
2181
|
*/
|
|
2208
|
-
GetSupportedFeaturesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2182
|
+
GetSupportedFeaturesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2209
2183
|
/**
|
|
2210
2184
|
* Removes the lock.
|
|
2211
2185
|
* @api
|
|
@@ -2215,7 +2189,7 @@ export namespace ITHit{
|
|
|
2215
2189
|
* @param {ITHit.WebDAV.Client.HierarchyItem~UnlockAsyncCallback} fCallback Function to call when operation is completed.
|
|
2216
2190
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2217
2191
|
*/
|
|
2218
|
-
UnlockAsync(sLockToken: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2192
|
+
UnlockAsync(sLockToken: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2219
2193
|
/**
|
|
2220
2194
|
* Updates values of properties exposed by this item.
|
|
2221
2195
|
* @api
|
|
@@ -2229,7 +2203,7 @@ export namespace ITHit{
|
|
|
2229
2203
|
* @param {ITHit.WebDAV.Client.HierarchyItem~UpdatePropertiesAsyncCallback} fCallback Function to call when operation is completed.
|
|
2230
2204
|
* @returns {ITHit.WebDAV.Client.WebDavRequest|null} WebDAV request
|
|
2231
2205
|
*/
|
|
2232
|
-
UpdatePropertiesAsync(oPropertiesToAddOrUpdate: ITHit.WebDAV.Client.Property[], oPropertiesToDelete: ITHit.WebDAV.Client.PropertyName[], sLockToken?: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.WebDavRequest | null;
|
|
2206
|
+
UpdatePropertiesAsync(oPropertiesToAddOrUpdate: ITHit.WebDAV.Client.Property[], oPropertiesToDelete: ITHit.WebDAV.Client.PropertyName[], sLockToken?: string | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.WebDavRequest | null;
|
|
2233
2207
|
}/**
|
|
2234
2208
|
* @classdesc Represents a search request.
|
|
2235
2209
|
* @constructs
|
|
@@ -2307,7 +2281,7 @@ export namespace ITHit{
|
|
|
2307
2281
|
* @param {ITHit.WebDAV.Client.Folder~CreateFolderAsyncCallback} fCallback Function to call when operation is completed.
|
|
2308
2282
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2309
2283
|
*/
|
|
2310
|
-
CreateFolderAsync(sName: string, sLockTokens?: string, aProperties?: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2284
|
+
CreateFolderAsync(sName: string, sLockTokens?: string | null, aProperties?: ITHit.WebDAV.Client.PropertyName[] | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2311
2285
|
/**
|
|
2312
2286
|
* Creates a new file with a specified name as a child of this folder.
|
|
2313
2287
|
* @api
|
|
@@ -2320,7 +2294,7 @@ export namespace ITHit{
|
|
|
2320
2294
|
* @param {ITHit.WebDAV.Client.Folder~CreateFileAsyncCallback} fCallback Function to call when operation is completed.
|
|
2321
2295
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2322
2296
|
*/
|
|
2323
|
-
CreateFileAsync(sName: string, sLockTokens: string, sContent: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2297
|
+
CreateFileAsync(sName: string, sLockTokens: string, sContent: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2324
2298
|
/**
|
|
2325
2299
|
* Gets specified number of children of this folder that correspond to requested offset and sorting. Use GetSupportedFeaturesAsync() function to detect if paging is supported.
|
|
2326
2300
|
* @api
|
|
@@ -2333,7 +2307,7 @@ export namespace ITHit{
|
|
|
2333
2307
|
* @param {ITHit.WebDAV.Client.Folder~GetPageAsyncCallback} fCallback Function to call when operation is completed.
|
|
2334
2308
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2335
2309
|
*/
|
|
2336
|
-
GetPageAsync(aProperties?: ITHit.WebDAV.Client.PropertyName[], nOffset?: number, nResults?: number, aOrderProperties?: ITHit.WebDAV.Client.OrderProperty[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2310
|
+
GetPageAsync(aProperties?: ITHit.WebDAV.Client.PropertyName[] | null, nOffset?: number | null, nResults?: number | null, aOrderProperties?: ITHit.WebDAV.Client.OrderProperty[] | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2337
2311
|
/**
|
|
2338
2312
|
* 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]{@link ITHit.WebDAV.Client.Folder#GetPageAsync} function instead.
|
|
2339
2313
|
* @api
|
|
@@ -2344,7 +2318,7 @@ export namespace ITHit{
|
|
|
2344
2318
|
* @param {ITHit.WebDAV.Client.Folder~GetChildrenAsyncCallback} fCallback Function to call when operation is completed.
|
|
2345
2319
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2346
2320
|
*/
|
|
2347
|
-
GetChildrenAsync(bRecursively: boolean, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2321
|
+
GetChildrenAsync(bRecursively: boolean, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2348
2322
|
/**
|
|
2349
2323
|
* Gets the specified folder from server.
|
|
2350
2324
|
* @api
|
|
@@ -2352,7 +2326,7 @@ export namespace ITHit{
|
|
|
2352
2326
|
* @param {ITHit.WebDAV.Client.Folder~GetFolderAsyncCallback} fCallback Function to call when operation is completed.
|
|
2353
2327
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2354
2328
|
*/
|
|
2355
|
-
GetFolderAsync(sName: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2329
|
+
GetFolderAsync(sName: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2356
2330
|
/**
|
|
2357
2331
|
* Gets the specified file from server.
|
|
2358
2332
|
* @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.GetItemByFolder.GetFile
|
|
@@ -2362,7 +2336,7 @@ export namespace ITHit{
|
|
|
2362
2336
|
* @param {ITHit.WebDAV.Client.Folder~GetFileAsyncCallback} fCallback Function to call when operation is completed.
|
|
2363
2337
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2364
2338
|
*/
|
|
2365
|
-
GetFileAsync(sName: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2339
|
+
GetFileAsync(sName: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2366
2340
|
/**
|
|
2367
2341
|
* Gets the specified item from server.
|
|
2368
2342
|
* @api
|
|
@@ -2370,7 +2344,7 @@ export namespace ITHit{
|
|
|
2370
2344
|
* @param {ITHit.WebDAV.Client.Folder~GetItemAsyncCallback} fCallback Function to call when operation is completed.
|
|
2371
2345
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2372
2346
|
*/
|
|
2373
|
-
GetItemAsync(sName: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2347
|
+
GetItemAsync(sName: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2374
2348
|
/**
|
|
2375
2349
|
* Checks whether specified item exists in the folder.
|
|
2376
2350
|
* @api
|
|
@@ -2380,7 +2354,7 @@ export namespace ITHit{
|
|
|
2380
2354
|
* @param {ITHit.WebDAV.Client.Folder~ItemExistsAsyncCallback} fCallback Function to call when operation is completed.
|
|
2381
2355
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2382
2356
|
*/
|
|
2383
|
-
ItemExistsAsync(sName: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2357
|
+
ItemExistsAsync(sName: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2384
2358
|
/**
|
|
2385
2359
|
* 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]{@link ITHit.WebDAV.Client.Folder#GetSearchPageByQueryAsync} function instead.
|
|
2386
2360
|
* @api
|
|
@@ -2390,7 +2364,7 @@ export namespace ITHit{
|
|
|
2390
2364
|
* @param {ITHit.WebDAV.Client.Folder~SearchByQueryAsyncCallback} fCallback Function to call when operation is completed.
|
|
2391
2365
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2392
2366
|
*/
|
|
2393
|
-
SearchByQueryAsync(oSearchQuery: ITHit.WebDAV.Client.SearchQuery, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2367
|
+
SearchByQueryAsync(oSearchQuery: ITHit.WebDAV.Client.SearchQuery, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2394
2368
|
/**
|
|
2395
2369
|
* 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.
|
|
2396
2370
|
* @api
|
|
@@ -2402,7 +2376,7 @@ export namespace ITHit{
|
|
|
2402
2376
|
* @param {ITHit.WebDAV.Client.Folder~GetSearchPageByQueryAsyncCallback} fCallback Function to call when operation is completed.
|
|
2403
2377
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2404
2378
|
*/
|
|
2405
|
-
GetSearchPageByQueryAsync(oSearchQuery: ITHit.WebDAV.Client.SearchQuery, nOffset?: number, nResults?: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2379
|
+
GetSearchPageByQueryAsync(oSearchQuery: ITHit.WebDAV.Client.SearchQuery, nOffset?: number | null, nResults?: number | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2406
2380
|
/**
|
|
2407
2381
|
* Searches folder by search string. To limit amount of items returned and get only a single results page use [GetSearchPageAsync]{@link ITHit.WebDAV.Client.Folder#GetSearchPageAsync} function instead.
|
|
2408
2382
|
* @api
|
|
@@ -2413,7 +2387,7 @@ export namespace ITHit{
|
|
|
2413
2387
|
* @param {ITHit.WebDAV.Client.Folder~SearchAsyncCallback} fCallback Function to call when operation is completed.
|
|
2414
2388
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2415
2389
|
*/
|
|
2416
|
-
SearchAsync(sSearchQuery: string, aProperties?: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2390
|
+
SearchAsync(sSearchQuery: string, aProperties?: ITHit.WebDAV.Client.PropertyName[] | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2417
2391
|
/**
|
|
2418
2392
|
* 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.
|
|
2419
2393
|
* @api
|
|
@@ -2426,7 +2400,7 @@ export namespace ITHit{
|
|
|
2426
2400
|
* @param {ITHit.WebDAV.Client.Folder~GetSearchPageAsyncCallback} fCallback Function to call when operation is completed.
|
|
2427
2401
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2428
2402
|
*/
|
|
2429
|
-
GetSearchPageAsync(sSearchQuery: string, aProperties?: ITHit.WebDAV.Client.PropertyName[], nOffset?: number, nResults?: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2403
|
+
GetSearchPageAsync(sSearchQuery: string, aProperties?: ITHit.WebDAV.Client.PropertyName[] | null, nOffset?: number | null, nResults?: number | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2430
2404
|
/**
|
|
2431
2405
|
* Current WebDAV session.
|
|
2432
2406
|
* @api
|
|
@@ -2516,7 +2490,7 @@ export namespace ITHit{
|
|
|
2516
2490
|
* @param {ITHit.WebDAV.Client.HierarchyItem~RefreshAsyncCallback} fCallback Function to call when operation is completed.
|
|
2517
2491
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2518
2492
|
*/
|
|
2519
|
-
RefreshAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2493
|
+
RefreshAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2520
2494
|
/**
|
|
2521
2495
|
* Copies this item to destination folder.
|
|
2522
2496
|
* @api
|
|
@@ -2529,17 +2503,17 @@ export namespace ITHit{
|
|
|
2529
2503
|
* @param {ITHit.WebDAV.Client.LockUriTokenPair[]} [oLockTokens] Lock tokens for destination folder.
|
|
2530
2504
|
* @param {ITHit.WebDAV.Client.HierarchyItem~CopyToAsyncCallback} fCallback Function to call when operation is completed.
|
|
2531
2505
|
*/
|
|
2532
|
-
CopyToAsync(oDestinationFolder: ITHit.WebDAV.Client.Folder, sDestinationName: string, bDeep: boolean, bOverwrite: boolean, oLockTokens?: ITHit.WebDAV.Client.LockUriTokenPair[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): void;
|
|
2506
|
+
CopyToAsync(oDestinationFolder: ITHit.WebDAV.Client.Folder, sDestinationName: string, bDeep: boolean, bOverwrite: boolean, oLockTokens?: ITHit.WebDAV.Client.LockUriTokenPair[] | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
|
|
2533
2507
|
/**
|
|
2534
2508
|
* Deletes this item.
|
|
2535
2509
|
* @api
|
|
2536
2510
|
* @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Delete.Delete
|
|
2537
2511
|
* @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Delete.Delete
|
|
2538
|
-
* @param {ITHit.WebDAV.Client.LockUriTokenPair} oLockTokens Lock tokens for this item or any locked child item.
|
|
2512
|
+
* @param {ITHit.WebDAV.Client.LockUriTokenPair | null} oLockTokens Lock tokens for this item or any locked child item.
|
|
2539
2513
|
* @param {ITHit.WebDAV.Client.HierarchyItem~DeleteAsyncCallback} fCallback Function to call when operation is completed.
|
|
2540
2514
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2541
2515
|
*/
|
|
2542
|
-
DeleteAsync(oLockTokens: ITHit.WebDAV.Client.LockUriTokenPair, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2516
|
+
DeleteAsync(oLockTokens: ITHit.WebDAV.Client.LockUriTokenPair | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2543
2517
|
/**
|
|
2544
2518
|
* Returns names of all custom properties exposed by this item.
|
|
2545
2519
|
* @api
|
|
@@ -2548,7 +2522,7 @@ export namespace ITHit{
|
|
|
2548
2522
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetPropertyNamesAsyncCallback} fCallback Function to call when operation is completed.
|
|
2549
2523
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2550
2524
|
*/
|
|
2551
|
-
GetPropertyNamesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2525
|
+
GetPropertyNamesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2552
2526
|
/**
|
|
2553
2527
|
* Retrieves values of specific properties.
|
|
2554
2528
|
* @api
|
|
@@ -2558,7 +2532,7 @@ export namespace ITHit{
|
|
|
2558
2532
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetPropertyValuesAsyncCallback} fCallback Function to call when operation is completed.
|
|
2559
2533
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2560
2534
|
*/
|
|
2561
|
-
GetPropertyValuesAsync(aNames: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2535
|
+
GetPropertyValuesAsync(aNames: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2562
2536
|
/**
|
|
2563
2537
|
* Retrieves all custom properties exposed by the item.
|
|
2564
2538
|
* @api
|
|
@@ -2567,7 +2541,7 @@ export namespace ITHit{
|
|
|
2567
2541
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetAllPropertiesAsyncCallback} fCallback Function to call when operation is completed.
|
|
2568
2542
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2569
2543
|
*/
|
|
2570
|
-
GetAllPropertiesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2544
|
+
GetAllPropertiesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2571
2545
|
/**
|
|
2572
2546
|
* Retrieves parent hierarchy item of this item.
|
|
2573
2547
|
* @api
|
|
@@ -2577,14 +2551,14 @@ export namespace ITHit{
|
|
|
2577
2551
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetParentAsyncCallback} fCallback Function to call when operation is completed.
|
|
2578
2552
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2579
2553
|
*/
|
|
2580
|
-
GetParentAsync(aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2554
|
+
GetParentAsync(aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2581
2555
|
/**
|
|
2582
2556
|
* Retrieves media type independent links.
|
|
2583
2557
|
* @api
|
|
2584
2558
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetSourceAsyncCallback} fCallback Function to call when operation is completed.
|
|
2585
2559
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2586
2560
|
*/
|
|
2587
|
-
GetSourceAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2561
|
+
GetSourceAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2588
2562
|
/**
|
|
2589
2563
|
* Locks the item. If the lock was successfully applied, the server will return a lock token. You will pass this
|
|
2590
2564
|
* lock token back to the server when updating and unlocking the item. The actual lock time applied by the server
|
|
@@ -2599,7 +2573,7 @@ export namespace ITHit{
|
|
|
2599
2573
|
* @param {ITHit.WebDAV.Client.HierarchyItem~LockAsyncCallback} fCallback Function to call when operation is completed.
|
|
2600
2574
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2601
2575
|
*/
|
|
2602
|
-
LockAsync(sLockScope: string, bDeep: boolean, sOwner: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2576
|
+
LockAsync(sLockScope: string, bDeep: boolean, sOwner: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2603
2577
|
/**
|
|
2604
2578
|
* Moves this item to another location.
|
|
2605
2579
|
* @api
|
|
@@ -2612,7 +2586,7 @@ export namespace ITHit{
|
|
|
2612
2586
|
* @param {ITHit.WebDAV.Client.HierarchyItem~MoveToAsyncCallback} fCallback Function to call when operation is completed.
|
|
2613
2587
|
* @return {ITHit.WebDAV.Client.Request} Request object.
|
|
2614
2588
|
*/
|
|
2615
|
-
MoveToAsync(oDestinationFolder: ITHit.WebDAV.Client.Folder, sDestinationName: string, bOverwrite: boolean, oLockTokens: string | ITHit.WebDAV.Client.LockUriTokenPair[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2589
|
+
MoveToAsync(oDestinationFolder: ITHit.WebDAV.Client.Folder, sDestinationName: string, bOverwrite: boolean, oLockTokens: string | ITHit.WebDAV.Client.LockUriTokenPair[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2616
2590
|
/**
|
|
2617
2591
|
* Prolongs the lock.
|
|
2618
2592
|
* @api
|
|
@@ -2623,7 +2597,7 @@ export namespace ITHit{
|
|
|
2623
2597
|
* @param {ITHit.WebDAV.Client.HierarchyItem~RefreshLockAsyncCallback} fCallback Function to call when operation is completed.
|
|
2624
2598
|
* @return {ITHit.WebDAV.Client.Request} Request object.
|
|
2625
2599
|
*/
|
|
2626
|
-
RefreshLockAsync(sLockToken: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2600
|
+
RefreshLockAsync(sLockToken: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2627
2601
|
/**
|
|
2628
2602
|
* Gets features supported by this item, such as WebDAV class support.
|
|
2629
2603
|
* @api
|
|
@@ -2632,7 +2606,7 @@ export namespace ITHit{
|
|
|
2632
2606
|
* @param {ITHit.WebDAV.Client.HierarchyItem~GetSupportedFeaturesAsyncCallback} fCallback Function to call when operation is completed.
|
|
2633
2607
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2634
2608
|
*/
|
|
2635
|
-
GetSupportedFeaturesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2609
|
+
GetSupportedFeaturesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2636
2610
|
/**
|
|
2637
2611
|
* Removes the lock.
|
|
2638
2612
|
* @api
|
|
@@ -2642,7 +2616,7 @@ export namespace ITHit{
|
|
|
2642
2616
|
* @param {ITHit.WebDAV.Client.HierarchyItem~UnlockAsyncCallback} fCallback Function to call when operation is completed.
|
|
2643
2617
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2644
2618
|
*/
|
|
2645
|
-
UnlockAsync(sLockToken: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2619
|
+
UnlockAsync(sLockToken: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2646
2620
|
/**
|
|
2647
2621
|
* Updates values of properties exposed by this item.
|
|
2648
2622
|
* @api
|
|
@@ -2656,7 +2630,7 @@ export namespace ITHit{
|
|
|
2656
2630
|
* @param {ITHit.WebDAV.Client.HierarchyItem~UpdatePropertiesAsyncCallback} fCallback Function to call when operation is completed.
|
|
2657
2631
|
* @returns {ITHit.WebDAV.Client.WebDavRequest|null} WebDAV request
|
|
2658
2632
|
*/
|
|
2659
|
-
UpdatePropertiesAsync(oPropertiesToAddOrUpdate: ITHit.WebDAV.Client.Property[], oPropertiesToDelete: ITHit.WebDAV.Client.PropertyName[], sLockToken?: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.WebDavRequest | null;
|
|
2633
|
+
UpdatePropertiesAsync(oPropertiesToAddOrUpdate: ITHit.WebDAV.Client.Property[], oPropertiesToDelete: ITHit.WebDAV.Client.PropertyName[], sLockToken?: string | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.WebDavRequest | null;
|
|
2660
2634
|
}/**
|
|
2661
2635
|
* Represents a version on a WebDAV server.
|
|
2662
2636
|
* @api
|
|
@@ -2689,7 +2663,7 @@ export namespace ITHit{
|
|
|
2689
2663
|
* @param {ITHit.WebDAV.Client.Version~UpdateToThisVersionAsync} fCallback Function to call when operation is completed.
|
|
2690
2664
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2691
2665
|
*/
|
|
2692
|
-
UpdateToThisAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2666
|
+
UpdateToThisAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2693
2667
|
/**
|
|
2694
2668
|
* Read file content. To download only a part of a file you can specify 2 parameters in ReadContent call.
|
|
2695
2669
|
* First parameter is the starting byte (zero-based) at witch to start content download, the second – amount
|
|
@@ -2702,7 +2676,7 @@ export namespace ITHit{
|
|
|
2702
2676
|
* @param {ITHit.WebDAV.Client.File~ReadContentAsyncCallback} fCallback Function to call when operation is completed.
|
|
2703
2677
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2704
2678
|
*/
|
|
2705
|
-
ReadContentAsync(iBytesFrom: number, iBytesCount: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2679
|
+
ReadContentAsync(iBytesFrom: number, iBytesCount: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2706
2680
|
/**
|
|
2707
2681
|
* Writes file content.
|
|
2708
2682
|
* @api
|
|
@@ -2712,14 +2686,14 @@ export namespace ITHit{
|
|
|
2712
2686
|
* @param {ITHit.WebDAV.Client.File~WriteContentAsyncCallback} fCallback Function to call when operation is completed.
|
|
2713
2687
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2714
2688
|
*/
|
|
2715
|
-
WriteContentAsync(sContent: string, sLockToken: string, sMimeType: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2689
|
+
WriteContentAsync(sContent: string, sLockToken: string, sMimeType: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2716
2690
|
/**
|
|
2717
2691
|
* Refreshes item loading data from server.
|
|
2718
2692
|
* @api
|
|
2719
2693
|
* @param {ITHit.WebDAV.Client.HierarchyItem~RefreshAsyncCallback} fCallback Function to call when operation is completed.
|
|
2720
2694
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2721
2695
|
*/
|
|
2722
|
-
RefreshAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
2696
|
+
RefreshAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2723
2697
|
/**
|
|
2724
2698
|
* Length of the file.
|
|
2725
2699
|
* @api
|
|
@@ -2870,25 +2844,36 @@ export namespace ITHit{
|
|
|
2870
2844
|
* @type {ITHit.WebDAV.Client.RequestProgress}
|
|
2871
2845
|
*/
|
|
2872
2846
|
Progress: ITHit.WebDAV.Client.RequestProgress
|
|
2847
|
+
/**
|
|
2848
|
+
* Progress info object, auto updated on `OnUploadProgress` event.
|
|
2849
|
+
* @public
|
|
2850
|
+
* @type {ITHit.WebDAV.Client.RequestProgress}
|
|
2851
|
+
*/
|
|
2852
|
+
UploadProgress: ITHit.WebDAV.Client.RequestProgress
|
|
2873
2853
|
/**
|
|
2874
2854
|
* @api
|
|
2875
2855
|
* @param {string} sEventName
|
|
2876
2856
|
* @param {function} fCallback
|
|
2877
2857
|
* @param {object} [oContext]
|
|
2878
2858
|
*/
|
|
2879
|
-
AddListener(sEventName: string, fCallback: Function, oContext?: object): void;
|
|
2859
|
+
AddListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
|
|
2880
2860
|
/**
|
|
2881
2861
|
* @api
|
|
2882
2862
|
* @param {string} sEventName
|
|
2883
2863
|
* @param {function} fCallback
|
|
2884
2864
|
* @param {object} [oContext]
|
|
2885
2865
|
*/
|
|
2886
|
-
RemoveListener(sEventName: string, fCallback: Function, oContext?: object): void;
|
|
2866
|
+
RemoveListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
|
|
2887
2867
|
/**
|
|
2888
2868
|
* Cancels asynchronous request. The Finish event and the callback function will be called immediately after this method call.
|
|
2889
2869
|
* @api
|
|
2890
2870
|
*/
|
|
2891
2871
|
Abort(): void;
|
|
2872
|
+
/**
|
|
2873
|
+
* Cancels asynchronous request. The Finish event and the callback function will not be called after this method call.
|
|
2874
|
+
* @public
|
|
2875
|
+
*/
|
|
2876
|
+
AbortAsync(): void;
|
|
2892
2877
|
}/**
|
|
2893
2878
|
* @classdesc Session for accessing WebDAV servers.
|
|
2894
2879
|
* @example
|
|
@@ -2981,14 +2966,488 @@ export namespace ITHit{
|
|
|
2981
2966
|
* @param {function} fCallback
|
|
2982
2967
|
* @param {object} [oContext]
|
|
2983
2968
|
*/
|
|
2984
|
-
AddListener(sEventName: string, fCallback: Function, oContext?: object): void;
|
|
2969
|
+
AddListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
|
|
2970
|
+
/**
|
|
2971
|
+
* @api
|
|
2972
|
+
* @param {string} sEventName
|
|
2973
|
+
* @param {function} fCallback
|
|
2974
|
+
* @param {object} [oContext]
|
|
2975
|
+
*/
|
|
2976
|
+
RemoveListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
|
|
2977
|
+
/**
|
|
2978
|
+
* Load File object corresponding to path.
|
|
2979
|
+
* @api
|
|
2980
|
+
* @param {string} sPath Path to the file.
|
|
2981
|
+
* @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
|
|
2982
|
+
* @param {ITHit.WebDAV.Client.WebDavSession~OpenFileAsyncCallback} fCallback Function to call when operation is completed.
|
|
2983
|
+
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2984
|
+
*/
|
|
2985
|
+
OpenFileAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
2986
|
+
/**
|
|
2987
|
+
* Returns Folder object corresponding to path.
|
|
2988
|
+
* @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.GetItemBySession.GetFolder
|
|
2989
|
+
* @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.GetItemBySession.GetFolder
|
|
2990
|
+
* @api
|
|
2991
|
+
* @param {string} sPath Path to the folder.
|
|
2992
|
+
* @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
|
|
2993
|
+
* @param {ITHit.WebDAV.Client.WebDavSession~OpenFolderAsyncCallback} fCallback Function to call when operation is completed.
|
|
2994
|
+
*/
|
|
2995
|
+
OpenFolderAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
|
|
2996
|
+
/**
|
|
2997
|
+
* Returns HierarchyItem object corresponding to path.
|
|
2998
|
+
* @api
|
|
2999
|
+
* @param {string} sPath Path to the resource.
|
|
3000
|
+
* @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
|
|
3001
|
+
* @param {ITHit.WebDAV.Client.WebDavSession~OpenItemAsyncCallback} fCallback Function to call when operation is completed.
|
|
3002
|
+
*/
|
|
3003
|
+
OpenItemAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
|
|
3004
|
+
/**
|
|
3005
|
+
* Creates folder corresponding to path.
|
|
3006
|
+
* @api
|
|
3007
|
+
* @param {string} sPath Path to the resource.
|
|
3008
|
+
* @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
|
|
3009
|
+
* @param {ITHit.WebDAV.Client.WebDavSession~CreateFolderAsyncCallback} fCallback Function to call when operation is completed.
|
|
3010
|
+
*/
|
|
3011
|
+
CreateFolderAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
|
|
3012
|
+
}
|
|
3013
|
+
namespace Upload{
|
|
3014
|
+
/**
|
|
3015
|
+
* Upload state.
|
|
3016
|
+
* @api
|
|
3017
|
+
* @enum {string}
|
|
3018
|
+
* @readonly
|
|
3019
|
+
* @class ITHit.WebDAV.Client.Upload.State
|
|
3020
|
+
*/
|
|
3021
|
+
enum State{
|
|
3022
|
+
Uploading = "Uploading",
|
|
3023
|
+
Canceled = "Canceled",
|
|
3024
|
+
Paused = "Paused",
|
|
3025
|
+
Queued = "Queued",
|
|
3026
|
+
Failed = "Failed",
|
|
3027
|
+
Completed = "Completed",
|
|
3028
|
+
Retrying = "Retrying",
|
|
3029
|
+
Skipped = "Skipped",
|
|
3030
|
+
}/**
|
|
3031
|
+
* This class represents progress state of upload.
|
|
3032
|
+
* @api
|
|
3033
|
+
* @class ITHit.WebDAV.Client.Upload.Progress
|
|
3034
|
+
*/
|
|
3035
|
+
class Progress {
|
|
3036
|
+
/**
|
|
3037
|
+
* Bytes uploaded.
|
|
3038
|
+
* @api
|
|
3039
|
+
* @type {!number}
|
|
3040
|
+
*/
|
|
3041
|
+
UploadedBytes: number
|
|
3042
|
+
/**
|
|
3043
|
+
* Total bytes to upload.
|
|
3044
|
+
* @api
|
|
3045
|
+
* @type {!number}
|
|
3046
|
+
*/
|
|
3047
|
+
TotalBytes: number
|
|
3048
|
+
/**
|
|
3049
|
+
* Elapsed time in seconds.
|
|
3050
|
+
* @api
|
|
3051
|
+
* @type {!number}
|
|
3052
|
+
*/
|
|
3053
|
+
ElapsedTime: number
|
|
3054
|
+
/**
|
|
3055
|
+
* Time left in seconds.
|
|
3056
|
+
* @api
|
|
3057
|
+
* @type {!number}
|
|
3058
|
+
*/
|
|
3059
|
+
RemainingTime: number
|
|
3060
|
+
/**
|
|
3061
|
+
* Progress in percents.
|
|
3062
|
+
* @api
|
|
3063
|
+
* @type {!number}
|
|
3064
|
+
*/
|
|
3065
|
+
Completed: number
|
|
3066
|
+
/**
|
|
3067
|
+
* Speed in bytes/s.
|
|
3068
|
+
* @api
|
|
3069
|
+
* @type {!number}
|
|
3070
|
+
*/
|
|
3071
|
+
Speed: number
|
|
3072
|
+
}/**
|
|
3073
|
+
* This class represents file or folder in unify form.
|
|
3074
|
+
* @public
|
|
3075
|
+
* @alias ITHit.WebDAV.Client.Upload.FSEntry
|
|
3076
|
+
* @constructs
|
|
3077
|
+
*
|
|
3078
|
+
* @param {string} sPath The path without resource name.
|
|
3079
|
+
* @param {File} [oFile] The file object.
|
|
3080
|
+
*/
|
|
3081
|
+
namespace FSEntry{
|
|
3082
|
+
/**
|
|
3083
|
+
* @public
|
|
3084
|
+
* @readonly
|
|
3085
|
+
*/
|
|
3086
|
+
function PathSeparator(): void;
|
|
3087
|
+
/**
|
|
3088
|
+
* Creates entry.
|
|
3089
|
+
* @public
|
|
3090
|
+
* @param {string[]} aPathParts
|
|
3091
|
+
* @param {File} [oFile]
|
|
3092
|
+
* @return {ITHit.WebDAV.Client.Upload.FSEntry}
|
|
3093
|
+
*/
|
|
3094
|
+
function CreateFromPathParts(aPathParts: string[], oFile?: File | null): ITHit.WebDAV.Client.Upload.FSEntry;
|
|
3095
|
+
}class FSEntry {
|
|
3096
|
+
constructor(sPath: string, oFile?: File | null);
|
|
3097
|
+
/**
|
|
3098
|
+
* Returns relative path of entry on file system.
|
|
3099
|
+
* @public
|
|
3100
|
+
* @return {string}
|
|
3101
|
+
*/
|
|
3102
|
+
GetRelativePath(): string;
|
|
3103
|
+
}/**
|
|
3104
|
+
* Represents a file or folder being uploaded. Provides functions to discover item state, get info about upload
|
|
3105
|
+
* progress as well as to pause, resume and cancel upload.
|
|
3106
|
+
* @api
|
|
3107
|
+
* @class ITHit.WebDAV.Client.Upload.UploadItem
|
|
3108
|
+
* @param {string} sUrl
|
|
3109
|
+
* @param {ITHit.WebDAV.Client.Upload.FSEntry} oFsEntry
|
|
3110
|
+
* @param {ITHit.WebDAV.Client.Upload.Controls.HtmlControl} oBinding
|
|
3111
|
+
* @param {ITHit.WebDAV.Client.Upload.UploaderSession} oSession
|
|
3112
|
+
* @param {ITHit.WebDAV.Client.Upload.Groups.GroupManager} oGroupManager
|
|
3113
|
+
* @param {ITHit.WebDAV.Client.Upload.Settings} oSettings
|
|
3114
|
+
*/
|
|
3115
|
+
class UploadItem {
|
|
3116
|
+
constructor(sUrl: string, oFsEntry: ITHit.WebDAV.Client.Upload.FSEntry, oBinding: ITHit.WebDAV.Client.Upload.Controls.HtmlControl, oSession: ITHit.WebDAV.Client.Upload.UploaderSession, oGroupManager: ITHit.WebDAV.Client.Upload.Groups.GroupManager, oSettings: ITHit.WebDAV.Client.Upload.Settings);
|
|
3117
|
+
/**
|
|
3118
|
+
* Event reporting that upload item state changed.
|
|
3119
|
+
* @api
|
|
3120
|
+
* @event ITHit.WebDAV.Client.Upload.UploadItem#OnStateChanged
|
|
3121
|
+
* @property {ITHit.WebDAV.Client.Upload.UploadItem} Sender Upload item instance.
|
|
3122
|
+
* @property {string} Name Event name.
|
|
3123
|
+
* @property {ITHit.WebDAV.Client.Upload.State} OldState Previous state.
|
|
3124
|
+
* @property {ITHit.WebDAV.Client.Upload.State} NewState Actual state.
|
|
3125
|
+
* @example
|
|
3126
|
+
* /** @typedef {ITHit.WebDAV.Client.Upload.UploadItem} oItem */
|
|
3127
|
+
* var oItem = oUploader.Queue.GetByUrl(sSomeUrl);
|
|
3128
|
+
* oItem.AddListener('OnStateChanged', function (oStateChanged) {
|
|
3129
|
+
* console.log('Upload to:' + oStateChanged.Sender.GetUrl() + ', changed state to :' + oStateChanged.NewState);
|
|
3130
|
+
* });
|
|
3131
|
+
*
|
|
3132
|
+
*/
|
|
3133
|
+
/**
|
|
3134
|
+
* Event reporting that upload item progress changed.
|
|
3135
|
+
* @api
|
|
3136
|
+
* @event ITHit.WebDAV.Client.Upload.UploadItem#OnProgressChanged
|
|
3137
|
+
* @property {ITHit.WebDAV.Client.Upload.UploadItem} Sender Upload item instance.
|
|
3138
|
+
* @property {string} Name Event name.
|
|
3139
|
+
* @property {ITHit.WebDAV.Client.Upload.Progress} OldProgress Previous progress.
|
|
3140
|
+
* @property {ITHit.WebDAV.Client.Upload.Progress} NewProgress Actual progress.
|
|
3141
|
+
* @example
|
|
3142
|
+
* /** @typedef {ITHit.WebDAV.Client.Upload.UploadItem} oItem */
|
|
3143
|
+
* var oItem = oUploader.Queue.GetByUrl(sSomeUrl);
|
|
3144
|
+
* oItem.AddListener('OnProgressChanged', function (oProgressChanged) {
|
|
3145
|
+
* console.log('Upload to:' + oStateChanged.Sender.GetUrl() + ', completed by:' + oProgressChanged.NewProgress.Completed + '%');
|
|
3146
|
+
* });
|
|
3147
|
+
*
|
|
3148
|
+
*/
|
|
3149
|
+
/**
|
|
3150
|
+
* Event reporting that upload error occurred.
|
|
3151
|
+
* @api
|
|
3152
|
+
* @event ITHit.WebDAV.Client.Upload.UploadItem#OnError
|
|
3153
|
+
* @property {ITHit.WebDAV.Client.Upload.UploadItem} Sender Upload item instance.
|
|
3154
|
+
* @property {string} Name Event name.
|
|
3155
|
+
* @property {Error|ITHit.WebDAV.Client.Exceptions.WebDavException} Error.
|
|
3156
|
+
* @example
|
|
3157
|
+
* /** @typedef {ITHit.WebDAV.Client.Upload.UploadItem} oItem */
|
|
3158
|
+
* var oItem = oUploader.Queue.GetByUrl(sSomeUrl);
|
|
3159
|
+
* oItem.AddListener('OnError', function (oOnError) {
|
|
3160
|
+
* console.log('Upload to:' + oOnError.Sender.GetUrl() + ', failed with error:' + oOnError.Error.toString());
|
|
3161
|
+
* });
|
|
3162
|
+
*
|
|
3163
|
+
*/
|
|
3164
|
+
/**
|
|
3165
|
+
* Event fired before {@link ITHit.WebDAV.Client.Upload.UploadItem} started upload.
|
|
3166
|
+
* You will validate item in this event and present user interface if user interaction is necessary.
|
|
3167
|
+
* In this event you can check if each item exists on the server and specify if item should be overwritten or skipped.
|
|
3168
|
+
* You can also validate file size, file extension, file upload path and file name.
|
|
3169
|
+
*
|
|
3170
|
+
* To continue upload the {@link ITHit.WebDAV.Client.Upload.Events.BeforeUploadStarted#Upload} function should be called.
|
|
3171
|
+
* To skip upload the {@link ITHit.WebDAV.Client.Upload.Events.BeforeUploadStarted#Skip} function should be called.
|
|
3172
|
+
* @api
|
|
3173
|
+
* @event ITHit.WebDAV.Client.Upload.UploadItem#OnBeforeUploadStarted
|
|
3174
|
+
* @type {ITHit.WebDAV.Client.Upload.Events.BeforeUploadStarted}
|
|
3175
|
+
* @example
|
|
3176
|
+
* /** @typedef {ITHit.WebDAV.Client.Upload.UploadItem} oItem */
|
|
3177
|
+
* var oItem = oUploader.Queue.GetByUrl(sSomeUrl);
|
|
3178
|
+
* oItem.AddListener('OnBeforeUploadStarted', function(oBeforeUploadStarted) {
|
|
3179
|
+
* WebDAVController.WebDavSession.OpenItemAsync(sHref,
|
|
3180
|
+
* [],
|
|
3181
|
+
* function(oAsyncResult) {
|
|
3182
|
+
* if (oAsyncResult.IsSuccess) {
|
|
3183
|
+
* oItem.SetSkip(true);
|
|
3184
|
+
* }
|
|
3185
|
+
*
|
|
3186
|
+
* oBeforeUploadStarted.Done();
|
|
3187
|
+
* });
|
|
3188
|
+
* });
|
|
3189
|
+
*/
|
|
3190
|
+
/**
|
|
3191
|
+
* Event fired when is possible to retry failed upload and waited until one of action called.
|
|
3192
|
+
* @api
|
|
3193
|
+
* @event ITHit.WebDAV.Client.Upload.UploadItem#OnUploadError
|
|
3194
|
+
* @type {ITHit.WebDAV.Client.Upload.Events.UploadError}
|
|
3195
|
+
* @example
|
|
3196
|
+
* /** @typedef {ITHit.WebDAV.Client.Upload.UploadItem} oItem */
|
|
3197
|
+
* var oItem = oUploader.Queue.GetByUrl(sSomeUrl);
|
|
3198
|
+
* AddListener('OnUploadError', function(oUploadError) {
|
|
3199
|
+
* setTimeout(function() {
|
|
3200
|
+
* oUploadError.Retry();
|
|
3201
|
+
* }, 2000)
|
|
3202
|
+
* });
|
|
3203
|
+
*/
|
|
3204
|
+
/**
|
|
3205
|
+
* Callback function to be called when action performed.
|
|
3206
|
+
* @api
|
|
3207
|
+
* @callback ITHit.WebDAV.Client.Upload.UploadItem~AsyncCallback
|
|
3208
|
+
*/
|
|
3209
|
+
/**
|
|
3210
|
+
* Gets [File]{@link https://www.w3.org/TR/FileAPI/} object. Returns null in case of a folder.
|
|
3211
|
+
* @api
|
|
3212
|
+
* @return {(File | null )}
|
|
3213
|
+
*/
|
|
3214
|
+
GetFile(): File | null;
|
|
3215
|
+
/**
|
|
3216
|
+
* Get target url.
|
|
3217
|
+
* @api
|
|
3218
|
+
* @return {string} File or folder target upload URL.
|
|
3219
|
+
*/
|
|
3220
|
+
GetUrl(): string;
|
|
3221
|
+
/**
|
|
3222
|
+
* Gets file or folder name with extension.
|
|
3223
|
+
* @api
|
|
3224
|
+
* @return {string} File or folder name.
|
|
3225
|
+
*/
|
|
3226
|
+
GetName(): string;
|
|
3227
|
+
/**
|
|
3228
|
+
* Gets relative path.
|
|
3229
|
+
* @api
|
|
3230
|
+
* @return {string} File or folder relative path.
|
|
3231
|
+
*/
|
|
3232
|
+
GetRelativePath(): string;
|
|
3233
|
+
/**
|
|
3234
|
+
* Gets current upload state.
|
|
3235
|
+
* @api
|
|
3236
|
+
* @return {(ITHit.WebDAV.Client.Upload.State | string)}
|
|
3237
|
+
*/
|
|
3238
|
+
GetState(): ITHit.WebDAV.Client.Upload.State | string;
|
|
3239
|
+
/**
|
|
3240
|
+
* Gets object that describes upload progress.
|
|
3241
|
+
* @api
|
|
3242
|
+
* @return {ITHit.WebDAV.Client.Upload.Progress }
|
|
3243
|
+
*/
|
|
3244
|
+
GetProgress(): ITHit.WebDAV.Client.Upload.Progress;
|
|
3245
|
+
/**
|
|
3246
|
+
* Gets all upload errors.
|
|
3247
|
+
* @api
|
|
3248
|
+
* @return {(Error[]|ITHit.WebDAV.Client.Exceptions.WebDavException[])}
|
|
3249
|
+
*/
|
|
3250
|
+
GetErrors(): Error[] | ITHit.WebDAV.Client.Exceptions.WebDavException[];
|
|
3251
|
+
/**
|
|
3252
|
+
* Gets last upload error.
|
|
3253
|
+
* @api
|
|
3254
|
+
* @return {(Error|ITHit.WebDAV.Client.Exceptions.WebDavException)}
|
|
3255
|
+
*/
|
|
3256
|
+
GetLastError(): Error | ITHit.WebDAV.Client.Exceptions.WebDavException;
|
|
3257
|
+
/**
|
|
3258
|
+
* Stores custom data.
|
|
3259
|
+
* @api
|
|
3260
|
+
* @type {Object}
|
|
3261
|
+
*/
|
|
3262
|
+
CustomData: Object
|
|
3263
|
+
/**
|
|
3264
|
+
* Sets if the item is overwritten if it exists on the server.
|
|
3265
|
+
* If false is passed and the file exists on the server upload will fail and the UploadItem will be set in the error state. Default is false.
|
|
3266
|
+
* @api
|
|
3267
|
+
* @param {boolean} Pass true to force the file to be overwritten. Pass false to make upload fail if file exists.
|
|
3268
|
+
*/
|
|
3269
|
+
SetOverwrite(Pass: boolean): void;
|
|
3270
|
+
/**
|
|
3271
|
+
* Adds HTTP header to upload. Note that depending on your web server and web browser,
|
|
3272
|
+
* maximum allowed request header size or size of all headers in total may be limited.
|
|
3273
|
+
* @api
|
|
3274
|
+
* @param {String} sName Header name.
|
|
3275
|
+
* @param {String} sValue Header value.
|
|
3276
|
+
*/
|
|
3277
|
+
AddHeader(sName: String, sValue: String): void;
|
|
3278
|
+
/**
|
|
3279
|
+
* Gets if the item will be overwritten if it exists on the server.
|
|
3280
|
+
* @api
|
|
3281
|
+
* @return {boolean} True if the file on the server will be overwritten. Otherwise - false. Default is false.
|
|
3282
|
+
*/
|
|
3283
|
+
GetOverwrite(): boolean;
|
|
3284
|
+
/**
|
|
3285
|
+
* Sets if the file should be deleted if upload is canceled.
|
|
3286
|
+
* By default, the file is deleted if the upload is canceled. To override this behavior, call this method passing false as a parameter.
|
|
3287
|
+
* This function must be called on files only.
|
|
3288
|
+
* @api
|
|
3289
|
+
* @param {boolean} bDelete Specifies if the file should be deleted on cancel. Typically you will pass false if the file existed before upload.
|
|
3290
|
+
* You will pass true to set the default behavior and delete the file when the upload is canceled.
|
|
3291
|
+
* @throws {ITHit.Exceptions.ArgumentException} Thrown if this function is called on folder item.
|
|
3292
|
+
*/
|
|
3293
|
+
SetDeleteOnCancel(bDelete: boolean): void;
|
|
3294
|
+
/**
|
|
3295
|
+
* Gets if the file is deleted when the upload is canceled.
|
|
3296
|
+
* @api
|
|
3297
|
+
* @return {boolean} True if file is deleted when upload is canceled. Otherwise - false. Default is true.
|
|
3298
|
+
*/
|
|
3299
|
+
GetDeleteOnCancel(): boolean;
|
|
3300
|
+
/**
|
|
3301
|
+
* Sets failed state.
|
|
3302
|
+
* Populates item's error with provided error instance.
|
|
3303
|
+
* @api
|
|
3304
|
+
* @param {ITHit.WebDAV.Client.Exceptions.WebDavException} oError - The error instance that will be set as a failure description.
|
|
3305
|
+
* @throws {ITHit.Exceptions.ArgumentException} - Thrown if argument is not derived from {@link ITHit.WebDAV.Client.Exceptions.WebDavException}.
|
|
3306
|
+
* @example
|
|
3307
|
+
* var oUploader = new ITHit.WebDAV.Client.Upload.Uploader();
|
|
3308
|
+
* oUploader.Queue.OnUploadItemsCreated = function(oUploadItemsCreated) {
|
|
3309
|
+
* var sErrorMessage = 'Added to queue in failed state';
|
|
3310
|
+
* var oWebDavException = new ITHit.WebDAV.Client.Exceptions.WebDavException(sMessage);
|
|
3311
|
+
*
|
|
3312
|
+
* /** @typedef {ITHit.WebDAV.Client.Upload.UploadItem[]} aItemsToUpload */
|
|
3313
|
+
* oUploadItemsCreated.Items.forEach(function(oItem) {
|
|
3314
|
+
* oItem.SetFailed(oWebDavException);
|
|
3315
|
+
* }
|
|
3316
|
+
*
|
|
3317
|
+
* oUploadItemsCreated.Upload(oUploadItemsCreated.Items);
|
|
3318
|
+
* });
|
|
3319
|
+
*
|
|
3320
|
+
*/
|
|
3321
|
+
SetFailed(oError: ITHit.WebDAV.Client.Exceptions.WebDavException): void;
|
|
3322
|
+
/**
|
|
3323
|
+
* Begins upload.
|
|
3324
|
+
* @api
|
|
3325
|
+
* @param {ITHit.WebDAV.Client.Upload.UploadItem~AsyncCallback} [fCallback] The callback to call when upload is paused.
|
|
3326
|
+
*/
|
|
3327
|
+
StartAsync(fCallback?: () => void | null): void;
|
|
3328
|
+
/**
|
|
3329
|
+
* Pauses upload.
|
|
3330
|
+
* @api
|
|
3331
|
+
* @param {ITHit.WebDAV.Client.Upload.UploadItem~AsyncCallback} [fCallback] The callback to call when upload is paused.
|
|
3332
|
+
*/
|
|
3333
|
+
PauseAsync(fCallback?: () => void | null): void;
|
|
3334
|
+
/**
|
|
3335
|
+
* Aborts upload.
|
|
3336
|
+
* @api
|
|
3337
|
+
* @param {number} [iTryCount] Number of times to try to delete the file if the file did not exist on the server before upload.
|
|
3338
|
+
* Pass 0 to not try to delete the file. Default is: 5.
|
|
3339
|
+
* @param {number} [iDelayAttempt] Delay between attempts to delete in milliseconds. Default is: 500.
|
|
3340
|
+
* @param {ITHit.WebDAV.Client.Upload.UploadItem~AsyncCallback} [fCallback] The callback to call when upload is cancelled.
|
|
3341
|
+
*/
|
|
3342
|
+
CancelAsync(iTryCount?: number | null, iDelayAttempt?: number | null, fCallback?: () => void | null): void;
|
|
3343
|
+
/**
|
|
3344
|
+
* Add event handlers.
|
|
3345
|
+
* @api
|
|
3346
|
+
* @param {string} sEventName The event name to handle.
|
|
3347
|
+
* @param {Function} fCallback The callback to call.
|
|
3348
|
+
* @param {object} [oContext] The context to callback is called with.
|
|
3349
|
+
*/
|
|
3350
|
+
AddListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
|
|
3351
|
+
/**
|
|
3352
|
+
* Remove event listener.
|
|
3353
|
+
* @api
|
|
3354
|
+
* @param {string} sEventName The event name to remove.
|
|
3355
|
+
* @param {Function} fCallback The callback to call.
|
|
3356
|
+
* @param {object} [oContext] The context to callback is called with.
|
|
3357
|
+
*/
|
|
3358
|
+
RemoveListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
|
|
3359
|
+
/**
|
|
3360
|
+
* @public
|
|
3361
|
+
* @return {ITHit.WebDAV.Client.Upload.Groups.GroupManager}
|
|
3362
|
+
*/
|
|
3363
|
+
GetGroup(): ITHit.WebDAV.Client.Upload.Groups.GroupManager;
|
|
3364
|
+
}/**
|
|
3365
|
+
* @alias ITHit.WebDAV.Client.Upload.FileSpan
|
|
3366
|
+
* @constructs
|
|
3367
|
+
* @public
|
|
3368
|
+
* @param {Blob} oFile
|
|
3369
|
+
* @param {number} [iStart]
|
|
3370
|
+
* @param {(number | null)} [iEnd]
|
|
3371
|
+
*/
|
|
3372
|
+
class FileSpan {
|
|
3373
|
+
constructor(oFile: Blob, iStart?: number | null, iEnd?: number | null);
|
|
3374
|
+
/**
|
|
3375
|
+
* Gets start of the span.
|
|
3376
|
+
* @public
|
|
3377
|
+
* @return {number}
|
|
3378
|
+
*/
|
|
3379
|
+
GetStart(): number;
|
|
3380
|
+
/**
|
|
3381
|
+
* Sets start of the span.
|
|
3382
|
+
* @public
|
|
3383
|
+
* @param {number} iStart
|
|
3384
|
+
*/
|
|
3385
|
+
SetStart(iStart: number): void;
|
|
3386
|
+
/**
|
|
3387
|
+
* Gets end of the span. Match end of file if null.
|
|
3388
|
+
* @public
|
|
3389
|
+
* @return {number}
|
|
3390
|
+
*/
|
|
3391
|
+
GetEnd(): number;
|
|
3392
|
+
/**
|
|
3393
|
+
* Sets end of the span. Match end of file if null.
|
|
3394
|
+
* @public
|
|
3395
|
+
* @param {(number | null)} iEnd
|
|
3396
|
+
*/
|
|
3397
|
+
SetEnd(iEnd: number | null): void;
|
|
3398
|
+
}/**
|
|
3399
|
+
* @public
|
|
3400
|
+
* @class ITHit.WebDAV.Client.Upload.UploaderSession
|
|
3401
|
+
* @extends ITHit.WebDAV.Client.WebDavSession
|
|
3402
|
+
*/
|
|
3403
|
+
class UploaderSession extends ITHit.WebDAV.Client.WebDavSession {
|
|
3404
|
+
/**
|
|
3405
|
+
* Returns progress report corresponding to path.
|
|
3406
|
+
* @public
|
|
3407
|
+
* @param {string} sUrl The url to resource.
|
|
3408
|
+
* @param {ITHit.WebDAV.Client.UploaderSession~GetProgressReportAsyncCallback} fCallback
|
|
3409
|
+
* @param {Object} [thisArg]
|
|
3410
|
+
* @return {* | ITHit.WebDAV.Client.Request} Request object.
|
|
3411
|
+
*/
|
|
3412
|
+
GetProgressReportAsync(sUrl: string, fCallback: (oResult: ITHit.WebDAV.Client.AsyncResult) => void, thisArg?: Object | null): any | ITHit.WebDAV.Client.Request;
|
|
3413
|
+
/**
|
|
3414
|
+
* The OnBeforeRequestSend event is fired before request is being submitted to server and provides all
|
|
3415
|
+
* information that is used when creating the request such as URL, HTTP verb, headers and request body.
|
|
3416
|
+
* @api
|
|
3417
|
+
* @examplecode ITHit.WebDAV.Client.Tests.WebDavSession.Events.BeforeRequestSend
|
|
3418
|
+
* @examplecode ITHit.WebDAV.Client.TSExamples.WebDavSession.Events.BeforeRequestSend
|
|
3419
|
+
* @event ITHit.WebDAV.Client.WebDavSession#OnBeforeRequestSend
|
|
3420
|
+
* @property {string} Method Request method
|
|
3421
|
+
* @property {string} Href Request absolute path
|
|
3422
|
+
* @property {object} Headers Key-value object with headers
|
|
3423
|
+
* @property {string} Body Request Body
|
|
3424
|
+
*/
|
|
3425
|
+
/**
|
|
3426
|
+
* The OnResponse event fires when the data is received from server. In your event handler you can update
|
|
3427
|
+
* any data received from server.
|
|
3428
|
+
* @api
|
|
3429
|
+
* @examplecode ITHit.WebDAV.Client.Tests.WebDavSession.Events.Response
|
|
3430
|
+
* @examplecode ITHit.WebDAV.Client.TSExamples.WebDavSession.Events.Response
|
|
3431
|
+
* @event ITHit.WebDAV.Client.WebDavSession#OnResponse
|
|
3432
|
+
* @property {number} Status Response status code
|
|
3433
|
+
* @property {string} StatusDescription Response status description
|
|
3434
|
+
* @property {object} Headers Key-value object with headers
|
|
3435
|
+
* @property {string} Body Response Body
|
|
3436
|
+
*/
|
|
3437
|
+
/**
|
|
3438
|
+
* @api
|
|
3439
|
+
* @param {string} sEventName
|
|
3440
|
+
* @param {function} fCallback
|
|
3441
|
+
* @param {object} [oContext]
|
|
3442
|
+
*/
|
|
3443
|
+
AddListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
|
|
2985
3444
|
/**
|
|
2986
3445
|
* @api
|
|
2987
3446
|
* @param {string} sEventName
|
|
2988
3447
|
* @param {function} fCallback
|
|
2989
3448
|
* @param {object} [oContext]
|
|
2990
3449
|
*/
|
|
2991
|
-
RemoveListener(sEventName: string, fCallback: Function, oContext?: object): void;
|
|
3450
|
+
RemoveListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
|
|
2992
3451
|
/**
|
|
2993
3452
|
* Load File object corresponding to path.
|
|
2994
3453
|
* @api
|
|
@@ -2997,7 +3456,7 @@ export namespace ITHit{
|
|
|
2997
3456
|
* @param {ITHit.WebDAV.Client.WebDavSession~OpenFileAsyncCallback} fCallback Function to call when operation is completed.
|
|
2998
3457
|
* @returns {ITHit.WebDAV.Client.Request} Request object.
|
|
2999
3458
|
*/
|
|
3000
|
-
OpenFileAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): ITHit.WebDAV.Client.Request;
|
|
3459
|
+
OpenFileAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
|
|
3001
3460
|
/**
|
|
3002
3461
|
* Returns Folder object corresponding to path.
|
|
3003
3462
|
* @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.GetItemBySession.GetFolder
|
|
@@ -3007,7 +3466,7 @@ export namespace ITHit{
|
|
|
3007
3466
|
* @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
|
|
3008
3467
|
* @param {ITHit.WebDAV.Client.WebDavSession~OpenFolderAsyncCallback} fCallback Function to call when operation is completed.
|
|
3009
3468
|
*/
|
|
3010
|
-
OpenFolderAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): void;
|
|
3469
|
+
OpenFolderAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
|
|
3011
3470
|
/**
|
|
3012
3471
|
* Returns HierarchyItem object corresponding to path.
|
|
3013
3472
|
* @api
|
|
@@ -3015,7 +3474,7 @@ export namespace ITHit{
|
|
|
3015
3474
|
* @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
|
|
3016
3475
|
* @param {ITHit.WebDAV.Client.WebDavSession~OpenItemAsyncCallback} fCallback Function to call when operation is completed.
|
|
3017
3476
|
*/
|
|
3018
|
-
OpenItemAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): void;
|
|
3477
|
+
OpenItemAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
|
|
3019
3478
|
/**
|
|
3020
3479
|
* Creates folder corresponding to path.
|
|
3021
3480
|
* @api
|
|
@@ -3023,5 +3482,601 @@ export namespace ITHit{
|
|
|
3023
3482
|
* @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
|
|
3024
3483
|
* @param {ITHit.WebDAV.Client.WebDavSession~CreateFolderAsyncCallback} fCallback Function to call when operation is completed.
|
|
3025
3484
|
*/
|
|
3026
|
-
CreateFolderAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void): void;
|
|
3027
|
-
}
|
|
3485
|
+
CreateFolderAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
|
|
3486
|
+
}/**
|
|
3487
|
+
* This class provides settings for Uploader.
|
|
3488
|
+
* @api
|
|
3489
|
+
* @class ITHit.WebDAV.Client.Upload.Settings
|
|
3490
|
+
*/
|
|
3491
|
+
class Settings {
|
|
3492
|
+
/**
|
|
3493
|
+
* Number of active uploads same time.
|
|
3494
|
+
* Number of concurrent uploads.
|
|
3495
|
+
* @api
|
|
3496
|
+
* @type {number}
|
|
3497
|
+
* @default 2
|
|
3498
|
+
*/
|
|
3499
|
+
ConcurrentUploads: number
|
|
3500
|
+
/**
|
|
3501
|
+
* Default queue state.
|
|
3502
|
+
* @api
|
|
3503
|
+
* @type {(ITHit.WebDAV.Client.Upload.State.Queued|string)}
|
|
3504
|
+
* @default ITHit.WebDAV.Client.Upload.State.Queued
|
|
3505
|
+
*/
|
|
3506
|
+
State: ITHit.WebDAV.Client.Upload.State.Queued | string
|
|
3507
|
+
/**
|
|
3508
|
+
* Default cancel behaviour.
|
|
3509
|
+
* @api
|
|
3510
|
+
* @type {!boolean}
|
|
3511
|
+
* @default true
|
|
3512
|
+
*/
|
|
3513
|
+
DeleteOnCancel: boolean
|
|
3514
|
+
}/**
|
|
3515
|
+
* List of items being uploaded. Each item in the list describes the file
|
|
3516
|
+
* or folder upload state and provides methods for managing upload.
|
|
3517
|
+
* @api
|
|
3518
|
+
* @class ITHit.WebDAV.Client.Upload.Queue
|
|
3519
|
+
* @fires ITHit.WebDAV.Client.Upload.Queue#OnQueueChanged
|
|
3520
|
+
*/
|
|
3521
|
+
class Queue {
|
|
3522
|
+
/**
|
|
3523
|
+
* Event reporting that queue changed. Fired when item is added or deleted from queue.
|
|
3524
|
+
* @api
|
|
3525
|
+
* @event ITHit.WebDAV.Client.Upload.Queue#OnQueueChanged
|
|
3526
|
+
* @property {ITHit.WebDAV.Client.Upload.Queue} Sender The queue instance.
|
|
3527
|
+
* @property {string} Name Event name.
|
|
3528
|
+
* @property {ITHit.WebDAV.Client.Upload.UploadItem[]} AddedItems Added items.
|
|
3529
|
+
* @property {ITHit.WebDAV.Client.Upload.UploadItem[]} RemovedItems Removed items.
|
|
3530
|
+
* @example
|
|
3531
|
+
* var oUploader = new ITHit.WebDAV.Client.Upload.Uploader();
|
|
3532
|
+
* oUploader.Queue.AddListener('OnQueueChanged', function (oQueueChanged) {
|
|
3533
|
+
*
|
|
3534
|
+
* oQueueChanged.AddedItems.forEach(function(element) {
|
|
3535
|
+
* console.log('Upload added:' + element.GetName());
|
|
3536
|
+
* });
|
|
3537
|
+
* };
|
|
3538
|
+
*/
|
|
3539
|
+
/**
|
|
3540
|
+
* Event fired {@link ITHit.WebDAV.Client.Upload.UploadItem}s are created.
|
|
3541
|
+
* You will validate files selected for upload in this event and present user interface if user interaction is necessary.
|
|
3542
|
+
* In this event you can check if each item exists on the server and specify if item should be overwritten or skipped.
|
|
3543
|
+
* You can also validate file size, file extension, file upload path and file name.
|
|
3544
|
+
*
|
|
3545
|
+
* To continue upload the {@link ITHit.WebDAV.Client.Upload.Events.UploadItemsCreated#Upload} function with the list of items to be uploaded should be called.
|
|
3546
|
+
* @api
|
|
3547
|
+
* @event ITHit.WebDAV.Client.Upload.Queue#OnUploadItemsCreated
|
|
3548
|
+
* @type {ITHit.WebDAV.Client.Upload.Events.UploadItemsCreated}
|
|
3549
|
+
* @example
|
|
3550
|
+
* var oUploader = new ITHit.WebDAV.Client.Upload.Uploader();
|
|
3551
|
+
* oUploader.Queue.AddListener('OnUploadItemsCreated', function(oUploadItemsCreated) {
|
|
3552
|
+
* var aIgnoredNames = ['file1.txt', 'file2.txt'];
|
|
3553
|
+
*
|
|
3554
|
+
* /** @typedef {ITHit.WebDAV.Client.Upload.UploadItem[]} aItems */
|
|
3555
|
+
* var aItems = oUploadItemsCreated.Items;
|
|
3556
|
+
* /** @typedef {ITHit.WebDAV.Client.Upload.UploadItem[]} aItemsToUpload */
|
|
3557
|
+
* var aItemsToUpload = aItems.filter(function(oItem) {
|
|
3558
|
+
* aIgnoredNames.indexOf(oItem.GetName()) < 0
|
|
3559
|
+
* }
|
|
3560
|
+
*
|
|
3561
|
+
* oUploadItemsCreated.Upload(aItemsToUpload);
|
|
3562
|
+
* });
|
|
3563
|
+
*
|
|
3564
|
+
*/
|
|
3565
|
+
/**
|
|
3566
|
+
* Associated uploader.
|
|
3567
|
+
* @api
|
|
3568
|
+
* @type {ITHit.WebDAV.Client.Upload.Uploader}
|
|
3569
|
+
*/
|
|
3570
|
+
Uploader: ITHit.WebDAV.Client.Upload.Uploader
|
|
3571
|
+
/**
|
|
3572
|
+
* Adds uploads to the queue.
|
|
3573
|
+
* @public
|
|
3574
|
+
* @param {string} sUrl Url to upload.
|
|
3575
|
+
* @param {ITHit.WebDAV.Client.Upload.FSEntry[]} aFSEntries Items to Upload.
|
|
3576
|
+
* @param {ITHit.WebDAV.Client.Upload.Controls.HtmlControl} [oSource] Source of items.
|
|
3577
|
+
*/
|
|
3578
|
+
AddGroup(sUrl: string, aFSEntries: ITHit.WebDAV.Client.Upload.FSEntry[], oSource?: ITHit.WebDAV.Client.Upload.Controls.HtmlControl | null): void;
|
|
3579
|
+
/**
|
|
3580
|
+
* @api
|
|
3581
|
+
* Restart queued upload of {@link ITHit.WebDAV.Client.Upload.UploadItem}s collection.
|
|
3582
|
+
* @param {ITHit.WebDAV.Client.Upload.UploadItem[]} aUploadItems Collection restart.
|
|
3583
|
+
*/
|
|
3584
|
+
Restart(aUploadItems: ITHit.WebDAV.Client.Upload.UploadItem[]): void;
|
|
3585
|
+
/**
|
|
3586
|
+
* Removes upload file from queue.
|
|
3587
|
+
* @param {string} sUrl The url of UploadItem to remove.
|
|
3588
|
+
* @api
|
|
3589
|
+
*/
|
|
3590
|
+
RemoveByUrl(sUrl: string): void;
|
|
3591
|
+
/**
|
|
3592
|
+
* Add event handlers.
|
|
3593
|
+
* @api
|
|
3594
|
+
* @param {string} sEventName The event name to handle.
|
|
3595
|
+
* @param {Function} fCallback The callback to call.
|
|
3596
|
+
* @param {Object} [oContext] The context to callback is called with.
|
|
3597
|
+
*/
|
|
3598
|
+
AddListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
|
|
3599
|
+
/**
|
|
3600
|
+
* Removes event listener.
|
|
3601
|
+
* @api
|
|
3602
|
+
* @param {string} sEventName The event name to remove.
|
|
3603
|
+
* @param {Function} fCallback The callback to remove.
|
|
3604
|
+
* @param {Object} [oContext] The context to callback is called with.
|
|
3605
|
+
*/
|
|
3606
|
+
RemoveListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
|
|
3607
|
+
}/**
|
|
3608
|
+
* Instance of this class store drop zones and provide methods to creating
|
|
3609
|
+
* and removing them
|
|
3610
|
+
* @api
|
|
3611
|
+
* @class ITHit.WebDAV.Client.Upload.DropZoneCollection
|
|
3612
|
+
*/
|
|
3613
|
+
class DropZoneCollection {
|
|
3614
|
+
/**
|
|
3615
|
+
* @api
|
|
3616
|
+
* @type {ITHit.WebDAV.Client.Upload.Uploader}
|
|
3617
|
+
*/
|
|
3618
|
+
Uploader: ITHit.WebDAV.Client.Upload.Uploader
|
|
3619
|
+
/**
|
|
3620
|
+
* Bind HTML element as drop zone.
|
|
3621
|
+
* @api
|
|
3622
|
+
* @example
|
|
3623
|
+
* <!DOCTYPE html>
|
|
3624
|
+
* <html>
|
|
3625
|
+
* <head>
|
|
3626
|
+
* <script type="text/javascript">
|
|
3627
|
+
* var oUploader = new ITHit.WebDAV.Client.Upload.Uploader();
|
|
3628
|
+
* oUploader.DropZones.AddById('ithit-dropzone');
|
|
3629
|
+
* </script>
|
|
3630
|
+
* </head>
|
|
3631
|
+
* <body
|
|
3632
|
+
* <div id="ithit-dropzone">
|
|
3633
|
+
* Drop file to upload<
|
|
3634
|
+
* </div>
|
|
3635
|
+
* </body>
|
|
3636
|
+
* </html>
|
|
3637
|
+
* @param {string} sElementId Id of HTML element.
|
|
3638
|
+
* @return {ITHit.WebDAV.Client.Upload.Controls.DropZone} Created drop zone.
|
|
3639
|
+
*/
|
|
3640
|
+
AddById(sElementId: string): ITHit.WebDAV.Client.Upload.Controls.DropZone;
|
|
3641
|
+
/**
|
|
3642
|
+
* Get drop zone by Id.
|
|
3643
|
+
* @api
|
|
3644
|
+
* @param {string} sElementId Id of HTML element.
|
|
3645
|
+
* @return {(ITHit.WebDAV.Client.Upload.Controls.DropZone | undefined)} Found drop zone or undefined.
|
|
3646
|
+
*/
|
|
3647
|
+
GetById(sElementId: string): ITHit.WebDAV.Client.Upload.Controls.DropZone | undefined;
|
|
3648
|
+
/**
|
|
3649
|
+
* Remove HTML element from drop zone Controls by id.
|
|
3650
|
+
* @api
|
|
3651
|
+
* @param {string} sElementId Id of HTML element.
|
|
3652
|
+
*/
|
|
3653
|
+
RemoveById(sElementId: string): void;
|
|
3654
|
+
/**
|
|
3655
|
+
* Add event handlers.
|
|
3656
|
+
* @public
|
|
3657
|
+
* @param {string} sEventName The event name to handle.
|
|
3658
|
+
* @param {Function} fCallback The callback to call.
|
|
3659
|
+
* @param {Object} [oContext] The context to callback is called with.
|
|
3660
|
+
*/
|
|
3661
|
+
AddListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
|
|
3662
|
+
/**
|
|
3663
|
+
* Removes event listener.
|
|
3664
|
+
* @public
|
|
3665
|
+
* @param {string} sEventName The event name to remove.
|
|
3666
|
+
* @param {Function} fCallback The callback to remove.
|
|
3667
|
+
* @param {Object} [oContext] The context to callback is called with.
|
|
3668
|
+
*/
|
|
3669
|
+
RemoveListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
|
|
3670
|
+
/**
|
|
3671
|
+
* Event reporting that collection changed. Fired when item is added or deleted from collection.
|
|
3672
|
+
* @public
|
|
3673
|
+
* @event ITHit.WebDAV.Client.Upload.DropZoneCollection#OnCollectionChanged
|
|
3674
|
+
* @property {ITHit.WebDAV.Client.Upload.DropZoneCollection} Sender The collection instance.
|
|
3675
|
+
* @property {ITHit.WebDAV.Client.Upload.Controls.DropZone[]} AddedItems Added items.
|
|
3676
|
+
* @property {ITHit.WebDAV.Client.Upload.Controls.DropZone[]} RemovedItems Removed items.
|
|
3677
|
+
*/
|
|
3678
|
+
}/**
|
|
3679
|
+
* List of upload inputs. Contains items of {@link ITHit.WebDAV.Client.Upload.Controls.Input} type.
|
|
3680
|
+
* @api
|
|
3681
|
+
* @class ITHit.WebDAV.Client.Upload.InputCollection
|
|
3682
|
+
*/
|
|
3683
|
+
class InputCollection {
|
|
3684
|
+
/**
|
|
3685
|
+
* @api
|
|
3686
|
+
* @type {ITHit.WebDAV.Client.Upload.Uploader}
|
|
3687
|
+
*/
|
|
3688
|
+
Uploader: ITHit.WebDAV.Client.Upload.Uploader
|
|
3689
|
+
/**
|
|
3690
|
+
* Bind HTML element as input.
|
|
3691
|
+
* @api
|
|
3692
|
+
* @example
|
|
3693
|
+
* <!DOCTYPE html>
|
|
3694
|
+
* <html>
|
|
3695
|
+
* <head>
|
|
3696
|
+
* <script type="text/javascript">
|
|
3697
|
+
* var oUploader = new ITHit.WebDAV.Client.Upload.Uploader();
|
|
3698
|
+
* oUploader.Inputs.AddById('ithit-input');
|
|
3699
|
+
* </script>
|
|
3700
|
+
* </head>
|
|
3701
|
+
* <body
|
|
3702
|
+
* <input id="ithit-input" type="file">
|
|
3703
|
+
* </body>
|
|
3704
|
+
* </html>
|
|
3705
|
+
* @param {string} sElementId Id of HTML element.
|
|
3706
|
+
* @return {ITHit.WebDAV.Client.Upload.Controls.Input} Created input object.
|
|
3707
|
+
*/
|
|
3708
|
+
AddById(sElementId: string): ITHit.WebDAV.Client.Upload.Controls.Input;
|
|
3709
|
+
/**
|
|
3710
|
+
* Get input object by Id.
|
|
3711
|
+
* @api
|
|
3712
|
+
* @param {string} sElementId Id of HTML element.
|
|
3713
|
+
* @return {ITHit.WebDAV.Client.Upload.Controls.Input | undefined} Founded input or undefined.
|
|
3714
|
+
*/
|
|
3715
|
+
GetById(sElementId: string): ITHit.WebDAV.Client.Upload.Controls.Input | undefined;
|
|
3716
|
+
/**
|
|
3717
|
+
* Remove HTML element from input Controls by id.
|
|
3718
|
+
* @api
|
|
3719
|
+
* @param {string} sElementId Id of HTML element.
|
|
3720
|
+
*/
|
|
3721
|
+
RemoveById(sElementId: string): void;
|
|
3722
|
+
/**
|
|
3723
|
+
* Add event handlers.
|
|
3724
|
+
* @public
|
|
3725
|
+
* @param {string} sEventName The event name to handle.
|
|
3726
|
+
* @param {Function} fCallback The callback to call.
|
|
3727
|
+
* @param {Object} [oContext] The context to callback is called with.
|
|
3728
|
+
*/
|
|
3729
|
+
AddListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
|
|
3730
|
+
/**
|
|
3731
|
+
* Removes event listener.
|
|
3732
|
+
* @public
|
|
3733
|
+
* @param {string} sEventName The event name to remove.
|
|
3734
|
+
* @param {Function} fCallback The callback to remove.
|
|
3735
|
+
* @param {Object} [oContext] The context to callback is called with.
|
|
3736
|
+
*/
|
|
3737
|
+
RemoveListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
|
|
3738
|
+
/**
|
|
3739
|
+
* Event reporting that collection changed. Fired when item is added or deleted from collection.
|
|
3740
|
+
* @public
|
|
3741
|
+
* @event ITHit.WebDAV.Client.Upload.InputCollection#OnCollectionChanged
|
|
3742
|
+
* @property {ITHit.WebDAV.Client.Upload.InputCollection} Sender The collection instance.
|
|
3743
|
+
* @property {ITHit.WebDAV.Client.Upload.Controls.Input[]} AddedItems Added items.
|
|
3744
|
+
* @property {ITHit.WebDAV.Client.Upload.Controls.Input[]} RemovedItems Removed items.
|
|
3745
|
+
*/
|
|
3746
|
+
}/**
|
|
3747
|
+
* Create uploader instance.
|
|
3748
|
+
* @example
|
|
3749
|
+
* <!DOCTYPE html>
|
|
3750
|
+
* <html lang="en">
|
|
3751
|
+
* <head>
|
|
3752
|
+
* <title>IT Hit WebDAV Uploader</title>
|
|
3753
|
+
* <script src="ITHitWebDAVClient.js" type="text/javascript"></script>
|
|
3754
|
+
* <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">
|
|
3755
|
+
* <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
|
|
3756
|
+
* <script type="text/javascript">
|
|
3757
|
+
* function UploaderGridView(sSelector) {
|
|
3758
|
+
* this.Uploader = new ITHit.WebDAV.Client.Upload.Uploader();
|
|
3759
|
+
* this.Uploader.DropZones.AddById('ithit-dropzone');
|
|
3760
|
+
* this.Uploader = oUploader;
|
|
3761
|
+
* this.Uploader.Queue.AddListener('OnQueueChanged', '_CollectionChange', this);
|
|
3762
|
+
* this.$table = $(sSelector);
|
|
3763
|
+
* this.rows = [];
|
|
3764
|
+
* };
|
|
3765
|
+
*
|
|
3766
|
+
* /**
|
|
3767
|
+
* * Observes adding and deleting of UploadItem and creates and removes rows in table.
|
|
3768
|
+
* * @param {ITHit.WebDAV.Client.Upload.Queue#OnQueueChanged} oQueueChanged
|
|
3769
|
+
* */
|
|
3770
|
+
* UploaderGridView.prototype._CollectionChange = function(oQueueChanged) {
|
|
3771
|
+
* $.each(oQueueChanged.AddedItems, function(index, value) {
|
|
3772
|
+
* var row = new UploaderGridRow(value);
|
|
3773
|
+
* this.rows.push(row);
|
|
3774
|
+
* this.$table.append(row.$el);
|
|
3775
|
+
* }.bind(this));
|
|
3776
|
+
*
|
|
3777
|
+
* $.each(oQueueChanged.RemovedItems, function(index, value) {
|
|
3778
|
+
* var aRows = $.grep(this.rows, function(oElem) { return value === oElem.UploadItem; });
|
|
3779
|
+
* var iIndex = this.rows.indexOf(aRows[0]);
|
|
3780
|
+
* this.rows.splice(iIndex, 1);
|
|
3781
|
+
* aRows[0].$el.remove();
|
|
3782
|
+
* }.bind(this));
|
|
3783
|
+
* };
|
|
3784
|
+
*
|
|
3785
|
+
* /**
|
|
3786
|
+
* * Represents table row and subscribes for upload change.
|
|
3787
|
+
* * @param {ITHit.WebDAV.Client.Upload.oUploadItem} oUploadItem
|
|
3788
|
+
* */
|
|
3789
|
+
* function UploaderGridRow(oUploadItem) {
|
|
3790
|
+
* this.$el = $('<tr></tr>');
|
|
3791
|
+
* this.oUploadItem = oUploadItem;
|
|
3792
|
+
* this.oUploadItem.AddListener('OnProgressChanged', '_OnProgress', this);
|
|
3793
|
+
* this.oUploadItem.AddListener('OnStateChanged', '_OnStateChange', this);
|
|
3794
|
+
* this._Render(oUploadItem);
|
|
3795
|
+
* };
|
|
3796
|
+
*
|
|
3797
|
+
*
|
|
3798
|
+
* /**
|
|
3799
|
+
* * Creates upload details view.
|
|
3800
|
+
* * @param {ITHit.WebDAV.Client.Upload.oUploadItem} oUploadItem
|
|
3801
|
+
* */
|
|
3802
|
+
* UploaderGridRow.prototype._Render = function(oUploadItem) {
|
|
3803
|
+
* /** @typedef {ITHit.WebDAV.Client.Upload.Progress} oProgress */
|
|
3804
|
+
* var oProgress = oUploadItem.GetProgress();
|
|
3805
|
+
* var columns = [
|
|
3806
|
+
* oUploadItem.GetName(),
|
|
3807
|
+
* oUploadItem.GetUrl(),
|
|
3808
|
+
* oUploadItem.GetSize(),
|
|
3809
|
+
* oProgress.UploadedBytes,
|
|
3810
|
+
* oProgress.Completed,
|
|
3811
|
+
* oProgress.ElapsedTime,
|
|
3812
|
+
* oProgress.RemainingTime,
|
|
3813
|
+
* oProgress.Speed,
|
|
3814
|
+
* oUploadItem.GetState()
|
|
3815
|
+
* ];
|
|
3816
|
+
*
|
|
3817
|
+
* var $columns = [];
|
|
3818
|
+
* columns.forEach(function(item) {
|
|
3819
|
+
* var $column = $('<td></td>');
|
|
3820
|
+
* $column.html(item);
|
|
3821
|
+
* $columns.push($column);
|
|
3822
|
+
* });
|
|
3823
|
+
*
|
|
3824
|
+
* var $actions = $('<td></td>');
|
|
3825
|
+
* this._RenderActions(oUploadItem).forEach(function(item) {
|
|
3826
|
+
* $actions.append(item);
|
|
3827
|
+
* });
|
|
3828
|
+
*
|
|
3829
|
+
* $columns.push($actions);
|
|
3830
|
+
* this.$el.empty();
|
|
3831
|
+
* this.$el.append($columns);
|
|
3832
|
+
* };
|
|
3833
|
+
*
|
|
3834
|
+
* /**
|
|
3835
|
+
* * Creates upload actions view.
|
|
3836
|
+
* * @param {ITHit.WebDAV.Client.Upload.oUploadItem} oUploadItem
|
|
3837
|
+
* */
|
|
3838
|
+
* UploaderGridRow.prototype._RenderActions = function(oUploadItem) {
|
|
3839
|
+
* var actions = [];
|
|
3840
|
+
* actions.push($('<a></a>').
|
|
3841
|
+
* html('<span class="glyphicon glyphicon-play"></span>').
|
|
3842
|
+
* attr('href', 'javascript:void(0)').
|
|
3843
|
+
* on('click', oUploadItem.StartAsync.bind(oUploadItem)));
|
|
3844
|
+
*
|
|
3845
|
+
* actions.push($('<a></a>').
|
|
3846
|
+
* html('<span class="glyphicon glyphicon-stop"></span>').
|
|
3847
|
+
* attr('href', 'javascript:void(0)').
|
|
3848
|
+
* on('click',oUploadItem.CancelAsync.bind(oUploadItem)));
|
|
3849
|
+
* };
|
|
3850
|
+
*
|
|
3851
|
+
* /**
|
|
3852
|
+
* * Handles UploadItem state change.
|
|
3853
|
+
* * @param {ITHit.WebDAV.Client.Upload.UploadItem#OnStateChanged} oStateChangedEvent
|
|
3854
|
+
* */
|
|
3855
|
+
* UploaderGridRow.prototype._OnStateChange = function(oStateChangedEvent) {
|
|
3856
|
+
* this._Render(oStateChangedEvent.Sender);
|
|
3857
|
+
* };
|
|
3858
|
+
*
|
|
3859
|
+
* /**
|
|
3860
|
+
* * Handles UploadItem progress change.
|
|
3861
|
+
* * @param {ITHit.WebDAV.Client.Upload.UploadItem#OnProgressChanged} oProgressEvent
|
|
3862
|
+
* */
|
|
3863
|
+
* UploaderGridRow.prototype._OnProgress = function(oProgressEvent) {
|
|
3864
|
+
* this._Render(oProgressEvent.Sender);
|
|
3865
|
+
* };
|
|
3866
|
+
*
|
|
3867
|
+
* var sUploadUrl = 'https://webdavserver/path/';
|
|
3868
|
+
* var oUploaderGrid = new UploaderGridView(oUploader, '.ithit-grid-uploads');
|
|
3869
|
+
* oUploaderGrid.Uploader.SetUploadUrl(sUploadUrl);
|
|
3870
|
+
* </script>
|
|
3871
|
+
* </head>
|
|
3872
|
+
* <body id="it-hit-dropzone">
|
|
3873
|
+
* <table class="table table-responsive ithit-grid-uploads">
|
|
3874
|
+
* <thead>
|
|
3875
|
+
* <tr>
|
|
3876
|
+
* <th>Display Name</th>
|
|
3877
|
+
* <th>Download Url</th>
|
|
3878
|
+
* <th>Size</th>
|
|
3879
|
+
* <th>Uploaded Bytes</th>
|
|
3880
|
+
* <th>Completed</th>
|
|
3881
|
+
* <th>Elapsed TimeSpan</th>
|
|
3882
|
+
* <th>Remaining TimeSpan</th>
|
|
3883
|
+
* <th>Speed</th>
|
|
3884
|
+
* <th>State</th>
|
|
3885
|
+
* <th>Actions</th>
|
|
3886
|
+
* </tr>
|
|
3887
|
+
* </thead>
|
|
3888
|
+
* <tbody>
|
|
3889
|
+
* </tbody>
|
|
3890
|
+
* </table>
|
|
3891
|
+
* </body>
|
|
3892
|
+
* </html>
|
|
3893
|
+
* @classdesc This class provides methods for managing file drop
|
|
3894
|
+
* zones, inputs and upload queue.
|
|
3895
|
+
* @api
|
|
3896
|
+
* @class ITHit.WebDAV.Client.Upload.Uploader
|
|
3897
|
+
* @constructs
|
|
3898
|
+
*/
|
|
3899
|
+
class Uploader {
|
|
3900
|
+
/**
|
|
3901
|
+
* Collection of associated drop zones.
|
|
3902
|
+
* @api
|
|
3903
|
+
* @readonly
|
|
3904
|
+
* @type { ITHit.WebDAV.Client.Upload.DropZoneCollection }
|
|
3905
|
+
*/
|
|
3906
|
+
readonly DropZones: ITHit.WebDAV.Client.Upload.DropZoneCollection
|
|
3907
|
+
/**
|
|
3908
|
+
* Collection of associated inputs.
|
|
3909
|
+
* @api
|
|
3910
|
+
* @readonly
|
|
3911
|
+
* @type { ITHit.WebDAV.Client.Upload.InputCollection }
|
|
3912
|
+
*/
|
|
3913
|
+
readonly Inputs: ITHit.WebDAV.Client.Upload.InputCollection
|
|
3914
|
+
/**
|
|
3915
|
+
* Queue of uploads.
|
|
3916
|
+
* @api
|
|
3917
|
+
* @readonly
|
|
3918
|
+
* @type {ITHit.WebDAV.Client.Upload.Queue}
|
|
3919
|
+
*/
|
|
3920
|
+
readonly Queue: ITHit.WebDAV.Client.Upload.Queue
|
|
3921
|
+
/**
|
|
3922
|
+
* Default settings for uploads.
|
|
3923
|
+
* @api
|
|
3924
|
+
* @type { ITHit.WebDAV.Client.Upload.Settings }
|
|
3925
|
+
*/
|
|
3926
|
+
Settings: ITHit.WebDAV.Client.Upload.Settings
|
|
3927
|
+
/**
|
|
3928
|
+
* Set upload url for drop zones and inputs.
|
|
3929
|
+
* @api
|
|
3930
|
+
* @param {string} sUrl Url to upload.
|
|
3931
|
+
*/
|
|
3932
|
+
SetUploadUrl(sUrl: string): void;
|
|
3933
|
+
/**
|
|
3934
|
+
* Get upload url for drop zones and inputs.
|
|
3935
|
+
* @api
|
|
3936
|
+
* @return {string} Upload url.
|
|
3937
|
+
*/
|
|
3938
|
+
GetUploadUrl(): string;
|
|
3939
|
+
}
|
|
3940
|
+
namespace Controls{
|
|
3941
|
+
/**
|
|
3942
|
+
* @api
|
|
3943
|
+
* Instance of this class provides binding for HTMLElement.
|
|
3944
|
+
* @class ITHit.WebDAV.Client.Upload.Controls.HtmlControl
|
|
3945
|
+
*/
|
|
3946
|
+
class HtmlControl {
|
|
3947
|
+
/**
|
|
3948
|
+
* Id attribute.
|
|
3949
|
+
* @api
|
|
3950
|
+
* @type {string}
|
|
3951
|
+
*/
|
|
3952
|
+
Id: string
|
|
3953
|
+
/**
|
|
3954
|
+
* Associated HTML Element
|
|
3955
|
+
* @api
|
|
3956
|
+
* @type {HTMLElement}
|
|
3957
|
+
*/
|
|
3958
|
+
HtmlElement: HTMLElement
|
|
3959
|
+
/**
|
|
3960
|
+
* Add event handlers.
|
|
3961
|
+
* @public
|
|
3962
|
+
* @param {string} sEventName The event name to handle.
|
|
3963
|
+
* @param {Function} fCallback The callback to call.
|
|
3964
|
+
* @param {Object} [oContext] The context to callback is called with.
|
|
3965
|
+
*/
|
|
3966
|
+
AddListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
|
|
3967
|
+
/**
|
|
3968
|
+
* Removes event listener.
|
|
3969
|
+
* @public
|
|
3970
|
+
* @param {string} sEventName The event name to remove.
|
|
3971
|
+
* @param {Function} fCallback The callback to remove.
|
|
3972
|
+
* @param {Object} [oContext] The context to callback is called with.
|
|
3973
|
+
*/
|
|
3974
|
+
RemoveListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
|
|
3975
|
+
/**
|
|
3976
|
+
* Event reporting that file handling finished..
|
|
3977
|
+
* @public
|
|
3978
|
+
* @event ITHit.WebDAV.Client.Upload.Controls.HtmlControl#OnFileInputHandled
|
|
3979
|
+
* @property {ITHit.WebDAV.Client.Upload.Controls.HtmlControl} Source The source of event.
|
|
3980
|
+
* @property {ITHit.WebDAV.Client.AsyncResult} AsyncResult Result.
|
|
3981
|
+
* @property {ITHit.WebDAV.Client.Upload.FSEntry[]} AsyncResult.Result Current uploader
|
|
3982
|
+
*/
|
|
3983
|
+
}/**
|
|
3984
|
+
* This class provides methods for creation of {@link ITHit.WebDAV.Client.Upload.FSEntryFactory}s.
|
|
3985
|
+
* @public
|
|
3986
|
+
* @class ITHit.WebDAV.Client.Upload.Controls.FSEntryFactory
|
|
3987
|
+
*/
|
|
3988
|
+
class FSEntryFactory {
|
|
3989
|
+
}/**
|
|
3990
|
+
* Instance of this class provides metadata for drop zone.
|
|
3991
|
+
* @api
|
|
3992
|
+
* @class ITHit.WebDAV.Client.Upload.Controls.DropZone
|
|
3993
|
+
* @extends ITHit.WebDAV.Client.Upload.Controls.HtmlControl
|
|
3994
|
+
*/
|
|
3995
|
+
class DropZone extends ITHit.WebDAV.Client.Upload.Controls.HtmlControl {
|
|
3996
|
+
/**
|
|
3997
|
+
* Id attribute.
|
|
3998
|
+
* @api
|
|
3999
|
+
* @type {string}
|
|
4000
|
+
*/
|
|
4001
|
+
Id: string
|
|
4002
|
+
/**
|
|
4003
|
+
* Associated HTML Element
|
|
4004
|
+
* @api
|
|
4005
|
+
* @type {HTMLElement}
|
|
4006
|
+
*/
|
|
4007
|
+
HtmlElement: HTMLElement
|
|
4008
|
+
/**
|
|
4009
|
+
* Add event handlers.
|
|
4010
|
+
* @public
|
|
4011
|
+
* @param {string} sEventName The event name to handle.
|
|
4012
|
+
* @param {Function} fCallback The callback to call.
|
|
4013
|
+
* @param {Object} [oContext] The context to callback is called with.
|
|
4014
|
+
*/
|
|
4015
|
+
AddListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
|
|
4016
|
+
/**
|
|
4017
|
+
* Removes event listener.
|
|
4018
|
+
* @public
|
|
4019
|
+
* @param {string} sEventName The event name to remove.
|
|
4020
|
+
* @param {Function} fCallback The callback to remove.
|
|
4021
|
+
* @param {Object} [oContext] The context to callback is called with.
|
|
4022
|
+
*/
|
|
4023
|
+
RemoveListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
|
|
4024
|
+
/**
|
|
4025
|
+
* Event reporting that file handling finished..
|
|
4026
|
+
* @public
|
|
4027
|
+
* @event ITHit.WebDAV.Client.Upload.Controls.HtmlControl#OnFileInputHandled
|
|
4028
|
+
* @property {ITHit.WebDAV.Client.Upload.Controls.HtmlControl} Source The source of event.
|
|
4029
|
+
* @property {ITHit.WebDAV.Client.AsyncResult} AsyncResult Result.
|
|
4030
|
+
* @property {ITHit.WebDAV.Client.Upload.FSEntry[]} AsyncResult.Result Current uploader
|
|
4031
|
+
*/
|
|
4032
|
+
}/**
|
|
4033
|
+
* Instance of this class provides metadata for input.
|
|
4034
|
+
* @class ITHit.WebDAV.Client.Upload.Controls.Input
|
|
4035
|
+
* @extends ITHit.WebDAV.Client.Upload.Controls.HtmlControl
|
|
4036
|
+
* @api
|
|
4037
|
+
*/
|
|
4038
|
+
class Input extends ITHit.WebDAV.Client.Upload.Controls.HtmlControl {
|
|
4039
|
+
/**
|
|
4040
|
+
* Id attribute.
|
|
4041
|
+
* @api
|
|
4042
|
+
* @type {string}
|
|
4043
|
+
*/
|
|
4044
|
+
Id: string
|
|
4045
|
+
/**
|
|
4046
|
+
* Associated HTML Element
|
|
4047
|
+
* @api
|
|
4048
|
+
* @type {HTMLElement}
|
|
4049
|
+
*/
|
|
4050
|
+
HtmlElement: HTMLElement
|
|
4051
|
+
/**
|
|
4052
|
+
* Add event handlers.
|
|
4053
|
+
* @public
|
|
4054
|
+
* @param {string} sEventName The event name to handle.
|
|
4055
|
+
* @param {Function} fCallback The callback to call.
|
|
4056
|
+
* @param {Object} [oContext] The context to callback is called with.
|
|
4057
|
+
*/
|
|
4058
|
+
AddListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
|
|
4059
|
+
/**
|
|
4060
|
+
* Removes event listener.
|
|
4061
|
+
* @public
|
|
4062
|
+
* @param {string} sEventName The event name to remove.
|
|
4063
|
+
* @param {Function} fCallback The callback to remove.
|
|
4064
|
+
* @param {Object} [oContext] The context to callback is called with.
|
|
4065
|
+
*/
|
|
4066
|
+
RemoveListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
|
|
4067
|
+
/**
|
|
4068
|
+
* Event reporting that file handling finished..
|
|
4069
|
+
* @public
|
|
4070
|
+
* @event ITHit.WebDAV.Client.Upload.Controls.HtmlControl#OnFileInputHandled
|
|
4071
|
+
* @property {ITHit.WebDAV.Client.Upload.Controls.HtmlControl} Source The source of event.
|
|
4072
|
+
* @property {ITHit.WebDAV.Client.AsyncResult} AsyncResult Result.
|
|
4073
|
+
* @property {ITHit.WebDAV.Client.Upload.FSEntry[]} AsyncResult.Result Current uploader
|
|
4074
|
+
*/
|
|
4075
|
+
}}
|
|
4076
|
+
namespace Groups{
|
|
4077
|
+
/**
|
|
4078
|
+
* @public
|
|
4079
|
+
* @class ITHit.WebDAV.Client.Upload.Groups.GroupManager
|
|
4080
|
+
*/
|
|
4081
|
+
class GroupManager {
|
|
4082
|
+
}}}}}}
|