webdav.client 6.0.8910 → 6.0.8913

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/index.d.ts DELETED
@@ -1,4414 +0,0 @@
1
- // -----------------------------------------------------------------------
2
- // IT Hit WebDAV Ajax Library v6.0.8910.0
3
- // Copyright © 2020 IT Hit LTD. All rights reserved.
4
- // License: https://www.webdavsystem.com/ajax/
5
- // -----------------------------------------------------------------------
6
-
7
- export namespace ITHit{
8
- /**
9
- * Base class for exceptions.
10
- * @api
11
- * @class ITHit.Exception
12
- */
13
- class Exception {
14
- /**
15
- * Exception message.
16
- * @api
17
- * @property {String} ITHit.Exception.Message
18
- * @type {string}
19
- */
20
- Message: string
21
- /**
22
- * Original exception that caused this exception.
23
- * @api
24
- * @property {ITHit.Exception} ITHit.Exception.InnerException
25
- * @type {ITHit.Exception}
26
- */
27
- InnerException: ITHit.Exception
28
- }/**
29
- * Detects environment in which JavaScript is running, such as operating system and web browser.
30
- * @api
31
- * @class ITHit.Environment
32
- */
33
- class Environment {
34
- }/**
35
- * Type of information being logged.
36
- * @api
37
- * @enum {number}
38
- * @class ITHit.LogLevel
39
- */
40
- class LogLevel {
41
- }/**
42
- * Provides static methods for logging.
43
- * @api
44
- * @class ITHit.Logger
45
- */
46
- namespace Logger{
47
- /**
48
- * Adds log listener.
49
- * @api
50
- * @param {ITHit.Logger~EventHandler} fHandler Handler function.
51
- * @param {number} iLogLevel Log level messages capturing.
52
- */
53
- function AddListener(fHandler: () => void, iLogLevel: number): void;
54
- /**
55
- * Removes log listener.
56
- * @api
57
- * @param {ITHit.Logger~EventHandler} fHandler Handler function.
58
- */
59
- function RemoveListener(fHandler?: () => void | null): void;
60
- /**
61
- * Writs a message to log with a specified log level. Default log level is {@link ITHit.LogLevel#Info}
62
- * @api
63
- * @param {string} sMessage Message to be logged.
64
- * @param {number} iLogLevel Logging level.
65
- * @throws ITHit.Exceptions.LoggerException Function was expected as log listener.
66
- */
67
- function WriteMessage(sMessage: string, iLogLevel: number): void;
68
- }class Logger {
69
- }
70
- namespace WebDAV{
71
- /**
72
- * This namespace provides classes for accessing WebDAV server items, file structure management, properties management and items locking.
73
- * @public
74
- * @namespace ITHit.WebDAV.Client
75
- * @class ITHit.WebDAV.Client
76
- */
77
- namespace Client{
78
- /**
79
- * The ITHit.WebDav.Client.Exceptions namespace provides classes that represent various WebDAV client library exceptions, erroneous server responses and HTTP errors.
80
- * @namespace ITHit.WebDAV.Client.Exceptions
81
- */
82
- namespace Exceptions{
83
- /**
84
- * Base exception for all exceptions thrown by WebDAV client library.
85
- * Initializes a new instance of the WebDavException class with a specified error message.
86
- * @api
87
- * @class ITHit.WebDAV.Client.Exceptions.WebDavException
88
- * @extends ITHit.Exception
89
- */
90
- class WebDavException extends ITHit.Exception {
91
- }/**
92
- * Is thrown whenever and erroneous http response is received. Initializes a new instance of the WebDavHttpException
93
- * class with a specified error message, a reference to the inner exception that is the cause of this exception,
94
- * href of the item, multistatus response and status of the response caused the error.
95
- * @api
96
- * @class ITHit.WebDAV.Client.Exceptions.WebDavHttpException
97
- * @extends ITHit.WebDAV.Client.Exceptions.WebDavException
98
- */
99
- class WebDavHttpException extends ITHit.WebDAV.Client.Exceptions.WebDavException {
100
- /**
101
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
102
- * @api
103
- * @type {ITHit.WebDAV.Client.Multistatus}
104
- */
105
- Multistatus: ITHit.WebDAV.Client.Multistatus
106
- /**
107
- * Http status with wich request failed.
108
- * @api
109
- * @type {ITHit.WebDAV.Client.HttpStatus}
110
- */
111
- Status: ITHit.WebDAV.Client.HttpStatus
112
- /**
113
- * Uri for which request failed.
114
- * @api
115
- * @type {string}
116
- */
117
- Uri: string
118
- /**
119
- * Error contains IError with additional info, if error information was available in response.
120
- * @api
121
- * @type {ITHit.WebDAV.Client.Error}
122
- */
123
- Error: ITHit.WebDAV.Client.Error
124
- }/**
125
- * Is raised whenever property processing was unsuccessfull. Initializes a new instance of the PropertyException
126
- * class with a specified error message, a reference to the inner exception that is the cause of this exception,
127
- * href of the item and multistatus response caused the error.
128
- * @api
129
- * @class ITHit.WebDAV.Client.Exceptions.PropertyException
130
- * @extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException
131
- */
132
- class PropertyException extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException {
133
- /**
134
- * Name of the property processing of which caused the exception.
135
- * @api
136
- * @type {ITHit.WebDAV.Client.PropertyName}
137
- */
138
- PropertyName: ITHit.WebDAV.Client.PropertyName
139
- /**
140
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
141
- * @api
142
- * @type {ITHit.WebDAV.Client.Multistatus}
143
- */
144
- Multistatus: ITHit.WebDAV.Client.Multistatus
145
- /**
146
- * Http status with wich request failed.
147
- * @api
148
- * @type {ITHit.WebDAV.Client.HttpStatus}
149
- */
150
- Status: ITHit.WebDAV.Client.HttpStatus
151
- /**
152
- * Uri for which request failed.
153
- * @api
154
- * @type {string}
155
- */
156
- Uri: string
157
- /**
158
- * Error contains IError with additional info, if error information was available in response.
159
- * @api
160
- * @type {ITHit.WebDAV.Client.Error}
161
- */
162
- Error: ITHit.WebDAV.Client.Error
163
- }/**
164
- * Thrown when server responded with Property Not Found http response. Initializes a new instance of the
165
- * PropertyNotFoundException class with a specified error message, a reference to the inner exception that
166
- * is the cause of this exception, href of the item and multistatus response caused the error.
167
- * @api
168
- * @class ITHit.WebDAV.Client.Exceptions.PropertyNotFoundException
169
- * @extends ITHit.WebDAV.Client.Exceptions.PropertyException
170
- */
171
- class PropertyNotFoundException extends ITHit.WebDAV.Client.Exceptions.PropertyException {
172
- /**
173
- * Name of the property processing of which caused the exception.
174
- * @api
175
- * @type {ITHit.WebDAV.Client.PropertyName}
176
- */
177
- PropertyName: ITHit.WebDAV.Client.PropertyName
178
- /**
179
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
180
- * @api
181
- * @type {ITHit.WebDAV.Client.Multistatus}
182
- */
183
- Multistatus: ITHit.WebDAV.Client.Multistatus
184
- /**
185
- * Http status with wich request failed.
186
- * @api
187
- * @type {ITHit.WebDAV.Client.HttpStatus}
188
- */
189
- Status: ITHit.WebDAV.Client.HttpStatus
190
- /**
191
- * Uri for which request failed.
192
- * @api
193
- * @type {string}
194
- */
195
- Uri: string
196
- /**
197
- * Error contains IError with additional info, if error information was available in response.
198
- * @api
199
- * @type {ITHit.WebDAV.Client.Error}
200
- */
201
- Error: ITHit.WebDAV.Client.Error
202
- }/**
203
- * Thrown when server responded with Property forbidden http response. Initializes a new instance of the
204
- * PropertyForbiddenException class with a specified error message, a reference to the inner exception
205
- * that is the cause of this exception, href of the item and multistatus response caused the error.
206
- * @api
207
- * @class ITHit.WebDAV.Client.Exceptions.PropertyForbiddenException
208
- * @extends ITHit.WebDAV.Client.Exceptions.PropertyException
209
- */
210
- class PropertyForbiddenException extends ITHit.WebDAV.Client.Exceptions.PropertyException {
211
- /**
212
- * Name of the property processing of which caused the exception.
213
- * @api
214
- * @type {ITHit.WebDAV.Client.PropertyName}
215
- */
216
- PropertyName: ITHit.WebDAV.Client.PropertyName
217
- /**
218
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
219
- * @api
220
- * @type {ITHit.WebDAV.Client.Multistatus}
221
- */
222
- Multistatus: ITHit.WebDAV.Client.Multistatus
223
- /**
224
- * Http status with wich request failed.
225
- * @api
226
- * @type {ITHit.WebDAV.Client.HttpStatus}
227
- */
228
- Status: ITHit.WebDAV.Client.HttpStatus
229
- /**
230
- * Uri for which request failed.
231
- * @api
232
- * @type {string}
233
- */
234
- Uri: string
235
- /**
236
- * Error contains IError with additional info, if error information was available in response.
237
- * @api
238
- * @type {ITHit.WebDAV.Client.Error}
239
- */
240
- Error: ITHit.WebDAV.Client.Error
241
- }/**
242
- * Base exception for all exceptions thrown by browser extension integration.
243
- * Initializes a new instance of the IntegrationException class with a specified error message.
244
- * @api
245
- * @class ITHit.WebDAV.Client.Exceptions.IntegrationException
246
- */
247
- class IntegrationException {
248
- }/**
249
- * Incorrect credentials provided or insufficient permissions to access the requested item. Initializes a new instance
250
- * of the UnauthorizedException class with a specified error message, a reference to the inner exception that is the
251
- * cause of this exception, href of the item and multistatus response caused the error.
252
- * @api
253
- * @class ITHit.WebDAV.Client.Exceptions.UnauthorizedException
254
- * @extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException
255
- */
256
- class UnauthorizedException extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException {
257
- /**
258
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
259
- * @api
260
- * @type {ITHit.WebDAV.Client.Multistatus}
261
- */
262
- Multistatus: ITHit.WebDAV.Client.Multistatus
263
- /**
264
- * Http status with wich request failed.
265
- * @api
266
- * @type {ITHit.WebDAV.Client.HttpStatus}
267
- */
268
- Status: ITHit.WebDAV.Client.HttpStatus
269
- /**
270
- * Uri for which request failed.
271
- * @api
272
- * @type {string}
273
- */
274
- Uri: string
275
- /**
276
- * Error contains IError with additional info, if error information was available in response.
277
- * @api
278
- * @type {ITHit.WebDAV.Client.Error}
279
- */
280
- Error: ITHit.WebDAV.Client.Error
281
- }/**
282
- * The request could not be understood by the server due to malformed syntax.
283
- * Initializes a new instance of the BadRequestException class with a specified error message, a reference to the
284
- * inner exception that is the cause of this exception, href of the item and multistatus response caused the error.
285
- * @api
286
- * @class ITHit.WebDAV.Client.Exceptions.BadRequestException
287
- * @extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException
288
- */
289
- class BadRequestException extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException {
290
- /**
291
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
292
- * @api
293
- * @type {ITHit.WebDAV.Client.Multistatus}
294
- */
295
- Multistatus: ITHit.WebDAV.Client.Multistatus
296
- /**
297
- * Http status with wich request failed.
298
- * @api
299
- * @type {ITHit.WebDAV.Client.HttpStatus}
300
- */
301
- Status: ITHit.WebDAV.Client.HttpStatus
302
- /**
303
- * Uri for which request failed.
304
- * @api
305
- * @type {string}
306
- */
307
- Uri: string
308
- /**
309
- * Error contains IError with additional info, if error information was available in response.
310
- * @api
311
- * @type {ITHit.WebDAV.Client.Error}
312
- */
313
- Error: ITHit.WebDAV.Client.Error
314
- }/**
315
- * The request could not be carried because of conflict on server.
316
- * Initializes a new instance of the ConflictException class with a specified error message, a reference
317
- * to the inner exception that is the cause of this exception, href of the item and multistatus response
318
- * caused the error.
319
- * @api
320
- * @class ITHit.WebDAV.Client.Exceptions.ConflictException
321
- * @extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException
322
- */
323
- class ConflictException extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException {
324
- /**
325
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
326
- * @api
327
- * @type {ITHit.WebDAV.Client.Multistatus}
328
- */
329
- Multistatus: ITHit.WebDAV.Client.Multistatus
330
- /**
331
- * Http status with wich request failed.
332
- * @api
333
- * @type {ITHit.WebDAV.Client.HttpStatus}
334
- */
335
- Status: ITHit.WebDAV.Client.HttpStatus
336
- /**
337
- * Uri for which request failed.
338
- * @api
339
- * @type {string}
340
- */
341
- Uri: string
342
- /**
343
- * Error contains IError with additional info, if error information was available in response.
344
- * @api
345
- * @type {ITHit.WebDAV.Client.Error}
346
- */
347
- Error: ITHit.WebDAV.Client.Error
348
- }/**
349
- * The item is locked. Initializes a new instance of the LockedException class with a specified error message,
350
- * a reference to the inner exception that is the cause of this exception, href of the item and multistatus
351
- * response caused the error.
352
- * @api
353
- * @class ITHit.WebDAV.Client.Exceptions.LockedException
354
- * @extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException
355
- */
356
- class LockedException extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException {
357
- /**
358
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
359
- * @api
360
- * @type {ITHit.WebDAV.Client.Multistatus}
361
- */
362
- Multistatus: ITHit.WebDAV.Client.Multistatus
363
- /**
364
- * Http status with wich request failed.
365
- * @api
366
- * @type {ITHit.WebDAV.Client.HttpStatus}
367
- */
368
- Status: ITHit.WebDAV.Client.HttpStatus
369
- /**
370
- * Uri for which request failed.
371
- * @api
372
- * @type {string}
373
- */
374
- Uri: string
375
- /**
376
- * Error contains IError with additional info, if error information was available in response.
377
- * @api
378
- * @type {ITHit.WebDAV.Client.Error}
379
- */
380
- Error: ITHit.WebDAV.Client.Error
381
- }/**
382
- * The server refused to fulfill the request. Initializes a new instance of the ForbiddenException class with
383
- * a specified error message, a reference to the inner exception that is the cause of this exception, href of
384
- * the item and multistatus response caused the error.
385
- * @api
386
- * @class ITHit.WebDAV.Client.Exceptions.ForbiddenException
387
- * @extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException
388
- */
389
- class ForbiddenException extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException {
390
- /**
391
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
392
- * @api
393
- * @type {ITHit.WebDAV.Client.Multistatus}
394
- */
395
- Multistatus: ITHit.WebDAV.Client.Multistatus
396
- /**
397
- * Http status with wich request failed.
398
- * @api
399
- * @type {ITHit.WebDAV.Client.HttpStatus}
400
- */
401
- Status: ITHit.WebDAV.Client.HttpStatus
402
- /**
403
- * Uri for which request failed.
404
- * @api
405
- * @type {string}
406
- */
407
- Uri: string
408
- /**
409
- * Error contains IError with additional info, if error information was available in response.
410
- * @api
411
- * @type {ITHit.WebDAV.Client.Error}
412
- */
413
- Error: ITHit.WebDAV.Client.Error
414
- }/**
415
- * The method is not allowed. Initializes a new instance of the MethodNotAllowedException class with a specified
416
- * error message, a reference to the inner exception that is the cause of this exception, href of the item and
417
- * multistatus response caused the error.
418
- * @api
419
- * @class ITHit.WebDAV.Client.Exceptions.MethodNotAllowedException
420
- * @extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException
421
- */
422
- class MethodNotAllowedException extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException {
423
- /**
424
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
425
- * @api
426
- * @type {ITHit.WebDAV.Client.Multistatus}
427
- */
428
- Multistatus: ITHit.WebDAV.Client.Multistatus
429
- /**
430
- * Http status with wich request failed.
431
- * @api
432
- * @type {ITHit.WebDAV.Client.HttpStatus}
433
- */
434
- Status: ITHit.WebDAV.Client.HttpStatus
435
- /**
436
- * Uri for which request failed.
437
- * @api
438
- * @type {string}
439
- */
440
- Uri: string
441
- /**
442
- * Error contains IError with additional info, if error information was available in response.
443
- * @api
444
- * @type {ITHit.WebDAV.Client.Error}
445
- */
446
- Error: ITHit.WebDAV.Client.Error
447
- }/**
448
- * The method is not implemented. Initializes a new instance of the NotImplementedException class with a specified
449
- * error message, a reference to the inner exception that is the cause of this exception, href of the item and
450
- * multistatus response caused the error.
451
- * @api
452
- * @class ITHit.WebDAV.Client.Exceptions.NotImplementedException
453
- * @extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException
454
- */
455
- class NotImplementedException extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException {
456
- /**
457
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
458
- * @api
459
- * @type {ITHit.WebDAV.Client.Multistatus}
460
- */
461
- Multistatus: ITHit.WebDAV.Client.Multistatus
462
- /**
463
- * Http status with wich request failed.
464
- * @api
465
- * @type {ITHit.WebDAV.Client.HttpStatus}
466
- */
467
- Status: ITHit.WebDAV.Client.HttpStatus
468
- /**
469
- * Uri for which request failed.
470
- * @api
471
- * @type {string}
472
- */
473
- Uri: string
474
- /**
475
- * Error contains IError with additional info, if error information was available in response.
476
- * @api
477
- * @type {ITHit.WebDAV.Client.Error}
478
- */
479
- Error: ITHit.WebDAV.Client.Error
480
- }/**
481
- * The item doesn't exist on the server. Initializes a new instance of the NotFoundException class with a specified
482
- * error message, a reference to the inner exception that is the cause of this exception, href of the item and
483
- * multistatus response caused the error.
484
- * @api
485
- * @class ITHit.WebDAV.Client.Exceptions.NotFoundException
486
- * @extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException
487
- */
488
- class NotFoundException extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException {
489
- /**
490
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
491
- * @api
492
- * @type {ITHit.WebDAV.Client.Multistatus}
493
- */
494
- Multistatus: ITHit.WebDAV.Client.Multistatus
495
- /**
496
- * Http status with wich request failed.
497
- * @api
498
- * @type {ITHit.WebDAV.Client.HttpStatus}
499
- */
500
- Status: ITHit.WebDAV.Client.HttpStatus
501
- /**
502
- * Uri for which request failed.
503
- * @api
504
- * @type {string}
505
- */
506
- Uri: string
507
- /**
508
- * Error contains IError with additional info, if error information was available in response.
509
- * @api
510
- * @type {ITHit.WebDAV.Client.Error}
511
- */
512
- Error: ITHit.WebDAV.Client.Error
513
- }/**
514
- * Precondition failed. Initializes a new instance of the PreconditionFailedException class with a specified error
515
- * message, a reference to the inner exception that is the cause of this exception, href of the item and multistatus
516
- * response with error details.
517
- * @api
518
- * @class ITHit.WebDAV.Client.Exceptions.PreconditionFailedException
519
- * @extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException
520
- */
521
- class PreconditionFailedException extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException {
522
- /**
523
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
524
- * @api
525
- * @type {ITHit.WebDAV.Client.Multistatus}
526
- */
527
- Multistatus: ITHit.WebDAV.Client.Multistatus
528
- /**
529
- * Http status with wich request failed.
530
- * @api
531
- * @type {ITHit.WebDAV.Client.HttpStatus}
532
- */
533
- Status: ITHit.WebDAV.Client.HttpStatus
534
- /**
535
- * Uri for which request failed.
536
- * @api
537
- * @type {string}
538
- */
539
- Uri: string
540
- /**
541
- * Error contains IError with additional info, if error information was available in response.
542
- * @api
543
- * @type {ITHit.WebDAV.Client.Error}
544
- */
545
- Error: ITHit.WebDAV.Client.Error
546
- }/**
547
- * The method could not be performed on the resource because the requested action depended on another action
548
- * and that action failed. Initializes a new instance of the DependencyFailedException class with a specified
549
- * error message, a reference to the inner exception that is the cause of this exception, href of the item
550
- * and multistatus response caused the error.
551
- * @api
552
- * @class ITHit.WebDAV.Client.Exceptions.DependencyFailedException
553
- * @extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException
554
- */
555
- class DependencyFailedException extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException {
556
- /**
557
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
558
- * @api
559
- * @type {ITHit.WebDAV.Client.Multistatus}
560
- */
561
- Multistatus: ITHit.WebDAV.Client.Multistatus
562
- /**
563
- * Http status with wich request failed.
564
- * @api
565
- * @type {ITHit.WebDAV.Client.HttpStatus}
566
- */
567
- Status: ITHit.WebDAV.Client.HttpStatus
568
- /**
569
- * Uri for which request failed.
570
- * @api
571
- * @type {string}
572
- */
573
- Uri: string
574
- /**
575
- * Error contains IError with additional info, if error information was available in response.
576
- * @api
577
- * @type {ITHit.WebDAV.Client.Error}
578
- */
579
- Error: ITHit.WebDAV.Client.Error
580
- }/**
581
- * Insufficient storage exception. Initializes a new instance of the InsufficientStorageException class with
582
- * a specified error message, a reference to the inner exception that is the cause of this exception, href of
583
- * the item and error response caused the error.
584
- * @api
585
- * @class ITHit.WebDAV.Client.Exceptions.InsufficientStorageException
586
- * @extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException
587
- */
588
- class InsufficientStorageException extends ITHit.WebDAV.Client.Exceptions.WebDavHttpException {
589
- /**
590
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
591
- * @api
592
- * @type {ITHit.WebDAV.Client.Multistatus}
593
- */
594
- Multistatus: ITHit.WebDAV.Client.Multistatus
595
- /**
596
- * Http status with wich request failed.
597
- * @api
598
- * @type {ITHit.WebDAV.Client.HttpStatus}
599
- */
600
- Status: ITHit.WebDAV.Client.HttpStatus
601
- /**
602
- * Uri for which request failed.
603
- * @api
604
- * @type {string}
605
- */
606
- Uri: string
607
- /**
608
- * Error contains IError with additional info, if error information was available in response.
609
- * @api
610
- * @type {ITHit.WebDAV.Client.Error}
611
- */
612
- Error: ITHit.WebDAV.Client.Error
613
- }/**
614
- * Quota not exceeded exception. Initializes a new instance of the QuotaNotExceededException class with a
615
- * specified error message, a reference to the inner exception that is the cause of this exception, href of
616
- * the item and error response caused the error.
617
- * @api
618
- * @class ITHit.WebDAV.Client.Exceptions.QuotaNotExceededException
619
- * @extends ITHit.WebDAV.Client.Exceptions.InsufficientStorageException
620
- */
621
- class QuotaNotExceededException extends ITHit.WebDAV.Client.Exceptions.InsufficientStorageException {
622
- /**
623
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
624
- * @api
625
- * @type {ITHit.WebDAV.Client.Multistatus}
626
- */
627
- Multistatus: ITHit.WebDAV.Client.Multistatus
628
- /**
629
- * Http status with wich request failed.
630
- * @api
631
- * @type {ITHit.WebDAV.Client.HttpStatus}
632
- */
633
- Status: ITHit.WebDAV.Client.HttpStatus
634
- /**
635
- * Uri for which request failed.
636
- * @api
637
- * @type {string}
638
- */
639
- Uri: string
640
- /**
641
- * Error contains IError with additional info, if error information was available in response.
642
- * @api
643
- * @type {ITHit.WebDAV.Client.Error}
644
- */
645
- Error: ITHit.WebDAV.Client.Error
646
- }/**
647
- * Sufficient disk space exception. Initializes a new instance of the SufficientDiskSpaceException class with
648
- * a specified error message, a reference to the inner exception that is the cause of this exception, href of
649
- * the item and error response caused the error.
650
- * @api
651
- * @class ITHit.WebDAV.Client.Exceptions.SufficientDiskSpaceException
652
- * @extends ITHit.WebDAV.Client.Exceptions.InsufficientStorageException
653
- */
654
- class SufficientDiskSpaceException extends ITHit.WebDAV.Client.Exceptions.InsufficientStorageException {
655
- /**
656
- * Multistatus Contains {@link ITHit.WebDAV.Client.Multistatus} with elements that had errors, if multistatus information was available in response.
657
- * @api
658
- * @type {ITHit.WebDAV.Client.Multistatus}
659
- */
660
- Multistatus: ITHit.WebDAV.Client.Multistatus
661
- /**
662
- * Http status with wich request failed.
663
- * @api
664
- * @type {ITHit.WebDAV.Client.HttpStatus}
665
- */
666
- Status: ITHit.WebDAV.Client.HttpStatus
667
- /**
668
- * Uri for which request failed.
669
- * @api
670
- * @type {string}
671
- */
672
- Uri: string
673
- /**
674
- * Error contains IError with additional info, if error information was available in response.
675
- * @api
676
- * @type {ITHit.WebDAV.Client.Error}
677
- */
678
- Error: ITHit.WebDAV.Client.Error
679
- }}/**
680
- * Initializes new instance of PropertyName.
681
- * @classdesc Represents name of property.
682
- * @constructs
683
- * @api
684
- * @param {string} sName Name of the property.
685
- * @param {string} sNamespaceUri Namespace of the property.
686
- * @throws ITHit.Exceptions.ArgumentNullException
687
- */
688
- class PropertyName {
689
- constructor(sName: string, sNamespaceUri: string);
690
- /**
691
- * Name of the property.
692
- * @api
693
- * @type {string}
694
- */
695
- Name: string
696
- /**
697
- * Namespace of the property.
698
- * @api
699
- * @type {string}
700
- */
701
- NamespaceUri: string
702
- /**
703
- * Returns string representation of current property name.
704
- * @api
705
- * @returns {string} String representation of current property name.
706
- */
707
- toString(): string;
708
- }/**
709
- * Structure that describes HTTP response's status.
710
- * @api
711
- * @class ITHit.WebDAV.Client.HttpStatus
712
- */
713
- namespace HttpStatus{
714
- /**
715
- * Parses HttpStatus structure from string containing status information.
716
- * @api
717
- * @param {string} sStatus String containing status information.
718
- * @returns {ITHit.WebDAV.Client.HttpStatus} HttpStatus structure that describes current status.
719
- */
720
- function Parse(sStatus: string): ITHit.WebDAV.Client.HttpStatus;
721
- }class HttpStatus {
722
- /**
723
- * No status defined.
724
- * @api
725
- * @type {ITHit.WebDAV.Client.HttpStatus}
726
- */
727
- static None: ITHit.WebDAV.Client.HttpStatus
728
- None: ITHit.WebDAV.Client.HttpStatus
729
- /**
730
- * The request requires user authentication.
731
- * @api
732
- * @type {ITHit.WebDAV.Client.HttpStatus}
733
- */
734
- static Unauthorized: ITHit.WebDAV.Client.HttpStatus
735
- Unauthorized: ITHit.WebDAV.Client.HttpStatus
736
- /**
737
- * The request has succeeded.
738
- * @api
739
- * @type {ITHit.WebDAV.Client.HttpStatus}
740
- */
741
- static OK: ITHit.WebDAV.Client.HttpStatus
742
- OK: ITHit.WebDAV.Client.HttpStatus
743
- /**
744
- * The request has been fulfilled and resulted in a new resource being created.
745
- * @api
746
- * @type {ITHit.WebDAV.Client.HttpStatus}
747
- */
748
- static Created: ITHit.WebDAV.Client.HttpStatus
749
- Created: ITHit.WebDAV.Client.HttpStatus
750
- /**
751
- * The server has fulfilled the request but does not need to return an entity-body, and might want to
752
- * return updated meta information.
753
- * @api
754
- * @type {ITHit.WebDAV.Client.HttpStatus}
755
- */
756
- static NoContent: ITHit.WebDAV.Client.HttpStatus
757
- NoContent: ITHit.WebDAV.Client.HttpStatus
758
- /**
759
- * The server has fulfilled the partial GET request for the resource.
760
- * @api
761
- * @type {ITHit.WebDAV.Client.HttpStatus}
762
- */
763
- static PartialContent: ITHit.WebDAV.Client.HttpStatus
764
- PartialContent: ITHit.WebDAV.Client.HttpStatus
765
- /**
766
- * This status code provides status for multiple independent operations.
767
- * @api
768
- * @type {ITHit.WebDAV.Client.HttpStatus}
769
- */
770
- static MultiStatus: ITHit.WebDAV.Client.HttpStatus
771
- MultiStatus: ITHit.WebDAV.Client.HttpStatus
772
- /**
773
- * This status code is used instead if 302 redirect. This is because 302 code is processed automatically
774
- * and there is no way to process redirect to login page.
775
- * @api
776
- * @type {ITHit.WebDAV.Client.HttpStatus}
777
- */
778
- static Redirect: ITHit.WebDAV.Client.HttpStatus
779
- Redirect: ITHit.WebDAV.Client.HttpStatus
780
- /**
781
- * The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat
782
- * the request without modifications.
783
- * @api
784
- * @type {ITHit.WebDAV.Client.HttpStatus}
785
- */
786
- static BadRequest: ITHit.WebDAV.Client.HttpStatus
787
- BadRequest: ITHit.WebDAV.Client.HttpStatus
788
- /**
789
- * The server has not found anything matching the Request-URI.
790
- * @api
791
- * @type {ITHit.WebDAV.Client.HttpStatus}
792
- */
793
- static NotFound: ITHit.WebDAV.Client.HttpStatus
794
- NotFound: ITHit.WebDAV.Client.HttpStatus
795
- /**
796
- * The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
797
- * @api
798
- * @type {ITHit.WebDAV.Client.HttpStatus}
799
- */
800
- static MethodNotAllowed: ITHit.WebDAV.Client.HttpStatus
801
- MethodNotAllowed: ITHit.WebDAV.Client.HttpStatus
802
- /**
803
- * The precondition given in one or more of the request-header fields evaluated to false when it was tested
804
- * on the server.
805
- * @api
806
- * @type {ITHit.WebDAV.Client.HttpStatus}
807
- */
808
- static PreconditionFailed: ITHit.WebDAV.Client.HttpStatus
809
- PreconditionFailed: ITHit.WebDAV.Client.HttpStatus
810
- /**
811
- * The source or destination resource of a method is locked.
812
- * @api
813
- * @type {ITHit.WebDAV.Client.HttpStatus}
814
- */
815
- static Locked: ITHit.WebDAV.Client.HttpStatus
816
- Locked: ITHit.WebDAV.Client.HttpStatus
817
- /**
818
- * The method could not be performed on the resource because the requested action depended on another
819
- * action and that action failed.
820
- * @api
821
- * @type {ITHit.WebDAV.Client.HttpStatus}
822
- */
823
- static DependencyFailed: ITHit.WebDAV.Client.HttpStatus
824
- DependencyFailed: ITHit.WebDAV.Client.HttpStatus
825
- /**
826
- * The server understood the request, but is refusing to fulfill it.
827
- * @api
828
- * @type {ITHit.WebDAV.Client.HttpStatus}
829
- */
830
- static Forbidden: ITHit.WebDAV.Client.HttpStatus
831
- Forbidden: ITHit.WebDAV.Client.HttpStatus
832
- /**
833
- * The request could not be completed due to a conflict with the current state of the resource.
834
- * @api
835
- * @type {ITHit.WebDAV.Client.HttpStatus}
836
- */
837
- static Conflict: ITHit.WebDAV.Client.HttpStatus
838
- Conflict: ITHit.WebDAV.Client.HttpStatus
839
- /**
840
- * The server does not support the functionality required to fulfill the request.
841
- * @api
842
- * @type {ITHit.WebDAV.Client.HttpStatus}
843
- */
844
- static NotImplemented: ITHit.WebDAV.Client.HttpStatus
845
- NotImplemented: ITHit.WebDAV.Client.HttpStatus
846
- /**
847
- * The server, while acting as a gateway or proxy, received an invalid response from the upstream
848
- * server it accessed in attempting to fulfill the request.
849
- * @api
850
- * @type {ITHit.WebDAV.Client.HttpStatus}
851
- */
852
- static BadGateway: ITHit.WebDAV.Client.HttpStatus
853
- BadGateway: ITHit.WebDAV.Client.HttpStatus
854
- /**
855
- * The method could not be performed on the resource because the server is unable to store the
856
- * representation needed to successfully complete the request.
857
- * @api
858
- * @type {ITHit.WebDAV.Client.HttpStatus}
859
- */
860
- static InsufficientStorage: ITHit.WebDAV.Client.HttpStatus
861
- InsufficientStorage: ITHit.WebDAV.Client.HttpStatus
862
- /**
863
- * @api
864
- * @type {number}
865
- */
866
- Code: number
867
- /**
868
- * @api
869
- * @type {string}
870
- */
871
- Description: string
872
- /**
873
- * Indicates whether the current HttpStatus structure is equal to another HttpStatus structure.
874
- * @api
875
- * @param {ITHit.WebDAV.Client.HttpStatus} oHttpStatus HttpStatus object to compare.
876
- * @returns {boolean} True if the current object is equal to the other parameter; otherwise, false.
877
- */
878
- Equals(oHttpStatus: ITHit.WebDAV.Client.HttpStatus): boolean;
879
- /**
880
- * Returns true if status is successful for Create operation.
881
- * @api
882
- * @returns {boolean} Returns true if status is successful for Create operation.
883
- */
884
- IsCreateOk(): boolean;
885
- /**
886
- * Returns true if status is successful for Delete operation.
887
- * @api
888
- * @returns {boolean} Returns true if status is successful for Delete operation.
889
- */
890
- IsDeleteOk(): boolean;
891
- /**
892
- * Returns true if status is successful.
893
- * @api
894
- * @returns {boolean} Returns true if status is successful.
895
- */
896
- IsOk(): boolean;
897
- /**
898
- * Returns true if status is successful for Copy or Move operation.
899
- * @api
900
- * @returns {boolean} Returns true if status is successful for Copy or Move operation.
901
- */
902
- IsCopyMoveOk(): boolean;
903
- /**
904
- * Returns true if status is successful for Get operation.
905
- * @api
906
- * @returns {boolean} Returns true if status is successful for Get operation.
907
- */
908
- IsGetOk(): boolean;
909
- /**
910
- * Returns true if status is successful for Put operation.
911
- * @api
912
- * @returns {boolean} Returns true if status is successful for Put operation.
913
- */
914
- IsPutOk(): boolean;
915
- /**
916
- * Returns true if status is successful for Unlock operation.
917
- * @api
918
- * @returns {boolean} Returns true if status is successful for Unlock operation.
919
- */
920
- IsUnlockOk(): boolean;
921
- /**
922
- * Returns true if status is successful for Head operation.
923
- * @api
924
- * @returns {boolean} Returns true if status is successful for Head operation.
925
- */
926
- IsHeadOk(): boolean;
927
- /**
928
- * Returns true if status is successful for Proppatch operation.
929
- * @api
930
- * @returns {boolean} Returns true if status is successful for Proppatch operation.
931
- */
932
- IsUpdateOk(): boolean;
933
- /**
934
- * Returns true if status is successful.
935
- * @api
936
- * @returns {boolean} Returns true if status is successful.
937
- */
938
- IsSuccess(): boolean;
939
- }/**
940
- * Initializes new string valued property.
941
- * @api
942
- * @classdesc Represents custom property exposed by WebDAV hierarchy items.
943
- * @constructs
944
- * @param {string|ITHit.WebDAV.Client.PropertyName} sName Name of the property.
945
- * @param {string} [sValue] Property value.
946
- * @param {string} [sNamespace] Namespace of the property.
947
- * @throws ITHit.Exception
948
- */
949
- class Property {
950
- constructor(sName: string | ITHit.WebDAV.Client.PropertyName, sValue?: string | null, sNamespace?: string | null);
951
- /**
952
- * Property Name.
953
- * @api
954
- * @type {string|ITHit.WebDAV.Client.PropertyName}
955
- */
956
- Name: string | ITHit.WebDAV.Client.PropertyName
957
- /**
958
- * Property value.
959
- * @api
960
- * @type {*}
961
- */
962
- Value: any
963
- /**
964
- * String value of the custom property.
965
- * @api
966
- * @returns {string} String value of the custom property.
967
- */
968
- StringValue(): string;
969
- }/**
970
- * Instance of this class is passed to callback function. It provides information about success or failure of
971
- * the operation as well as you will use it to get the results of the asynchronous call.
972
- * @api
973
- * @class ITHit.WebDAV.Client.AsyncResult
974
- */
975
- class AsyncResult {
976
- /**
977
- * Result value. Can be any type, each method may put there appropriate object which before was returned directly.
978
- * Null if request was unsuccessful.
979
- * @api
980
- * @type {*}
981
- */
982
- Result: any
983
- /**
984
- * Flag of either async request result was successful or not.
985
- * @api
986
- * @type {boolean}
987
- */
988
- IsSuccess: boolean
989
- /**
990
- * Error (Exception) object. Describes the type of error that occurred. Null if request was successful.
991
- * @api
992
- * @type {ITHit.WebDAV.Client.Exceptions.WebDavException|Error|null}
993
- */
994
- Error: ITHit.WebDAV.Client.Exceptions.WebDavException | Error | null
995
- /**
996
- * Status of HTTP response retrieved either from Result or Error objects
997
- * @api
998
- * @type {ITHit.WebDAV.Client.HttpStatus}
999
- */
1000
- Status: ITHit.WebDAV.Client.HttpStatus
1001
- }/**
1002
- * Initializes new instance of OrderProperty.
1003
- * @api
1004
- * @classdesc WebDAV order Property.
1005
- * @constructs
1006
- * @param {ITHit.WebDAV.Client.PropertyName} sProperty Property name.
1007
- * @param {boolean} sAscending Order direction.
1008
- */
1009
- class OrderProperty {
1010
- constructor(sProperty: ITHit.WebDAV.Client.PropertyName, sAscending: boolean);
1011
- /**
1012
- * Property name.
1013
- * @api
1014
- * @type {ITHit.WebDAV.Client.PropertyName}
1015
- */
1016
- Property: ITHit.WebDAV.Client.PropertyName
1017
- /**
1018
- * Order direction.
1019
- * @api
1020
- * @type {boolean}
1021
- */
1022
- Ascending: boolean
1023
- /**
1024
- * Returns string representation of current property name.
1025
- * @api
1026
- * @returns {string} String representation of current property name.
1027
- */
1028
- toString(): string;
1029
- }/**
1030
- * Enumeration of the item (Resource or Folder).
1031
- * @api
1032
- * @enum {string}
1033
- * @class ITHit.WebDAV.Client.ResourceType
1034
- */
1035
- enum ResourceType{
1036
- Folder = "Folder",
1037
- File = "Resource",
1038
- }/**
1039
- * List of WebDAV properties.
1040
- * @api
1041
- * @class ITHit.WebDAV.Client.PropertyList
1042
- * @extends Array
1043
- */
1044
- class PropertyList extends Array {
1045
- /**
1046
- * Returns true if the with the specified property name and namespace exists in property list.
1047
- * Returns false if does not exist.
1048
- * @api
1049
- * @param {ITHit.WebDAV.Client.PropertyName} oPropName Property name to search for.
1050
- * @param {boolean} [bIgnoreCase] Specifies if the search is case sensitive or case insensitive.
1051
- * @returns {boolean}
1052
- */
1053
- Has(oPropName: ITHit.WebDAV.Client.PropertyName, bIgnoreCase?: boolean | null): boolean;
1054
- /**
1055
- * Gets property value found by property name and namespace. Returns null if property with such name does not exist.
1056
- * @api
1057
- * @param {ITHit.WebDAV.Client.PropertyName} oPropName Property name to search for.
1058
- * @param {boolean} [bIgnoreCase] Specifies if the search is case sensitive or case insensitive.
1059
- * @returns {(string|null)} String representing property value or null if property with such name does not exist.
1060
- */
1061
- Find(oPropName: ITHit.WebDAV.Client.PropertyName, bIgnoreCase?: boolean | null): string | null;
1062
- }/**
1063
- * Represents information about errors occurred in different elements.
1064
- * @api
1065
- * @class ITHit.WebDAV.Client.Multistatus
1066
- */
1067
- class Multistatus {
1068
- /**
1069
- * Gets the generic description, if available.
1070
- * @api
1071
- * @type {string}
1072
- */
1073
- Description: string
1074
- /**
1075
- * Array of the errors returned by server.
1076
- * @api
1077
- * @type {ITHit.WebDAV.Client.MultistatusResponse[]}
1078
- */
1079
- Responses: ITHit.WebDAV.Client.MultistatusResponse[]
1080
- }/**
1081
- * Represents error occurred in one element.
1082
- * @api
1083
- * @class ITHit.WebDAV.Client.MultistatusResponse
1084
- */
1085
- class MultistatusResponse {
1086
- /**
1087
- * Request href
1088
- * @api
1089
- * @type {string}
1090
- */
1091
- Href: string
1092
- /**
1093
- * Array of the errors returned by server.
1094
- * @api
1095
- * @type {string}
1096
- */
1097
- Description: string
1098
- /**
1099
- * HTTP Status of the operation.
1100
- * @api
1101
- * @type {ITHit.WebDAV.Client.HttpStatus}
1102
- */
1103
- Status: ITHit.WebDAV.Client.HttpStatus
1104
- }/**
1105
- * Provides means for finding which properties failed to update.
1106
- * @api
1107
- * @class ITHit.WebDAV.Client.PropertyMultistatusResponse
1108
- * @extends ITHit.WebDAV.Client.MultistatusResponse
1109
- */
1110
- class PropertyMultistatusResponse extends ITHit.WebDAV.Client.MultistatusResponse {
1111
- /**
1112
- * Name of the property, if element is property. Otherwise null.
1113
- * @api
1114
- * @type {ITHit.WebDAV.Client.PropertyName}
1115
- */
1116
- PropertyName: ITHit.WebDAV.Client.PropertyName
1117
- /**
1118
- * Request href
1119
- * @api
1120
- * @type {string}
1121
- */
1122
- Href: string
1123
- /**
1124
- * Array of the errors returned by server.
1125
- * @api
1126
- * @type {string}
1127
- */
1128
- Description: string
1129
- /**
1130
- * HTTP Status of the operation.
1131
- * @api
1132
- * @type {ITHit.WebDAV.Client.HttpStatus}
1133
- */
1134
- Status: ITHit.WebDAV.Client.HttpStatus
1135
- }/**
1136
- * Scope of the lock.
1137
- * Represents exclusive or shared lock.
1138
- * @api
1139
- * @enum {string}
1140
- * @class ITHit.WebDAV.Client.LockScope
1141
- */
1142
- enum LockScope{
1143
- Exclusive = "Exclusive",
1144
- Shared = "Shared",
1145
- }/**
1146
- * Represents pair of resource uri - lock token. Is used to access locked resources.
1147
- * @api
1148
- * @class ITHit.WebDAV.Client.LockUriTokenPair
1149
- */
1150
- class LockUriTokenPair {
1151
- /**
1152
- * Path to the locked resource.
1153
- * @api
1154
- * @type {string}
1155
- */
1156
- Href: string
1157
- /**
1158
- * Lock token.
1159
- * @api
1160
- * @type {string}
1161
- */
1162
- LockToken: string
1163
- }/**
1164
- * Information about lock set on an item.
1165
- * @api
1166
- * @class ITHit.WebDAV.Client.LockInfo
1167
- */
1168
- class LockInfo {
1169
- /**
1170
- * Scope of the lock.
1171
- * @api
1172
- * @type {ITHit.WebDAV.Client.LockScope}
1173
- */
1174
- LockScope: ITHit.WebDAV.Client.LockScope
1175
- /**
1176
- * Whether lock is set on item's children.
1177
- * @api
1178
- * @type {boolean}
1179
- */
1180
- Deep: boolean
1181
- /**
1182
- * Timeout until lock expires.
1183
- * @api
1184
- * @type {number}
1185
- */
1186
- TimeOut: number
1187
- /**
1188
- * Owner's name.
1189
- * @api
1190
- * @type {string}
1191
- */
1192
- Owner: string
1193
- /**
1194
- * Lock token.
1195
- * @api
1196
- * @type {ITHit.WebDAV.Client.LockUriTokenPair}
1197
- */
1198
- LockToken: ITHit.WebDAV.Client.LockUriTokenPair
1199
- }/**
1200
- * Options of an item, described by supported HTTP extensions.
1201
- * @api
1202
- * @class ITHit.WebDAV.Client.OptionsInfo
1203
- */
1204
- class OptionsInfo {
1205
- /**
1206
- * Features supported by WebDAV server. See Features Enumeration {@link ITHit.WebDAV.Client.Features}.
1207
- * @api
1208
- * @type {number}
1209
- */
1210
- Features: number
1211
- }/**
1212
- * Represents features supported by WebDAV server.
1213
- * @api
1214
- * @enum {number}
1215
- * @class ITHit.WebDAV.Client.Features
1216
- */
1217
- class Features {
1218
- /**
1219
- * WebDAV Class 1 compliant item.
1220
- * Class 1 items does not support locking.
1221
- * @api
1222
- * @readonly
1223
- * @type {number}
1224
- */
1225
- static readonly Class1: number
1226
- readonly Class1: number
1227
- /**
1228
- * WebDAV Class 2 compliant item.
1229
- * Class 2 items support locking.
1230
- * @api
1231
- * @readonly
1232
- * @type {number}
1233
- */
1234
- static readonly Class2: number
1235
- readonly Class2: number
1236
- /**
1237
- * WebDAV Class 3 compliant item.
1238
- * @api
1239
- * @readonly
1240
- * @type {number}
1241
- */
1242
- static readonly Class3: number
1243
- readonly Class3: number
1244
- /**
1245
- * WevDAV paging compliant item.
1246
- * @api
1247
- * @readonly
1248
- * @type {number}
1249
- */
1250
- static readonly VersionControl: number
1251
- readonly VersionControl: number
1252
- /**
1253
- * DeltaV version-control compliant item.
1254
- * @api
1255
- * @readonly
1256
- * @type {number}
1257
- */
1258
- static readonly Paging: number
1259
- readonly Paging: number
1260
- /**
1261
- * Checkout-in-place item support check out, check in and uncheckout operations.
1262
- * @api
1263
- * @readonly
1264
- * @type {number}
1265
- */
1266
- static readonly CheckoutInPlace: number
1267
- readonly CheckoutInPlace: number
1268
- /**
1269
- * DeltaV Version History compliant item.
1270
- * @api
1271
- * @readonly
1272
- * @type {number}
1273
- */
1274
- static readonly VersionHistory: number
1275
- readonly VersionHistory: number
1276
- /**
1277
- * DeltaV Update compliant item.
1278
- * @api
1279
- * @readonly
1280
- * @type {number}
1281
- */
1282
- static readonly Update: number
1283
- readonly Update: number
1284
- /**
1285
- * The item supports resumable upload.
1286
- * @api
1287
- * @readonly
1288
- * @type {number}
1289
- */
1290
- static readonly ResumableUpload: number
1291
- readonly ResumableUpload: number
1292
- /**
1293
- * The item supports resumable download.
1294
- * @api
1295
- * @readonly
1296
- * @type {number}
1297
- */
1298
- static readonly ResumableDownload: number
1299
- readonly ResumableDownload: number
1300
- /**
1301
- * The item supports search.
1302
- * @api
1303
- * @readonly
1304
- * @type {number}
1305
- */
1306
- static readonly Dasl: number
1307
- readonly Dasl: number
1308
- /**
1309
- * The item supports GSuite editing.
1310
- * @api
1311
- * @readonly
1312
- * @type {number}
1313
- */
1314
- static readonly GSuite: number
1315
- readonly GSuite: number
1316
- }/**
1317
- * Represents one WebDAV item (file, folder or lock-null).
1318
- * @api
1319
- * @class ITHit.WebDAV.Client.HierarchyItem
1320
- */
1321
- class HierarchyItem {
1322
- /**
1323
- * Current WebDAV session.
1324
- * @api
1325
- * @type {ITHit.WebDAV.Client.WebDavSession}
1326
- */
1327
- Session: ITHit.WebDAV.Client.WebDavSession
1328
- /**
1329
- * This item path on the server.
1330
- * @api
1331
- * @type {string}
1332
- */
1333
- Href: string
1334
- /**
1335
- * Most recent modification date.
1336
- * @api
1337
- * @type {Date}
1338
- */
1339
- LastModified: Date
1340
- /**
1341
- * User friendly item name.
1342
- * @api
1343
- * @type {string}
1344
- */
1345
- DisplayName: string
1346
- /**
1347
- * The date item was created.
1348
- * @api
1349
- * @type {Date}
1350
- */
1351
- CreationDate: Date
1352
- /**
1353
- * Type of the item (File or Folder).
1354
- * @api
1355
- * @type {string}
1356
- * @see ITHit.WebDAV.Client.ResourceType
1357
- */
1358
- ResourceType: string
1359
- /**
1360
- * Retrieves information about supported locks. Item can support exclusive, shared locks or do not support
1361
- * any locks. If you set exclusive lock other users will not be able to set any locks. If you set shared
1362
- * lock other users will be able to set shared lock on the item.
1363
- * @api
1364
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.CheckSupport.CheckLockSupport
1365
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.CheckSupport.CheckLockSupport
1366
- * @type {Array.<string>}
1367
- * @see ITHit.WebDAV.Client.LockScope
1368
- */
1369
- SupportedLocks: string[]
1370
- /**
1371
- * List of locks applied to this item.
1372
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.GetLocks.GetList
1373
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.GetLocks.GetList
1374
- * @api
1375
- * @type {Array.<ITHit.WebDAV.Client.LockInfo>}
1376
- */
1377
- ActiveLocks: ITHit.WebDAV.Client.LockInfo[]
1378
- /**
1379
- * List of item properties.
1380
- * @api
1381
- * @type {ITHit.WebDAV.Client.PropertyList}
1382
- */
1383
- Properties: ITHit.WebDAV.Client.PropertyList
1384
- /**
1385
- * Returns true if file is under version control. Otherwise false. To detect if version control could
1386
- * be enabled for this item call GetSupportedFeaturesAsync and check for VersionControl token.
1387
- * To enable version control call PutUnderVersionControlAsync.
1388
- * @api
1389
- * @returns {boolean} Boolean, if true - versions supported
1390
- */
1391
- /**
1392
- * Number of bytes available for this user on server. -1 if server does not support Quota.
1393
- * @api
1394
- * @type {number}
1395
- */
1396
- AvailableBytes: number
1397
- /**
1398
- * Number of bytes used by this user on server. -1 if server does not support Quota.
1399
- * @api
1400
- * @type {number}
1401
- */
1402
- UsedBytes: number
1403
- /**
1404
- * Refreshes item loading data from server.
1405
- * @api
1406
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Refresh.Refresh
1407
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Refresh.Refresh
1408
- * @param {ITHit.WebDAV.Client.HierarchyItem~RefreshAsyncCallback} fCallback Function to call when operation is completed.
1409
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1410
- */
1411
- RefreshAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1412
- /**
1413
- * Copies this item to destination folder.
1414
- * @api
1415
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.CopyMove.Copy
1416
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.CopyMove.Copy
1417
- * @param {ITHit.WebDAV.Client.Folder} oDestinationFolder Folder to move to.
1418
- * @param {string} sDestinationName Name to assign to copied item.
1419
- * @param {boolean} bDeep Indicates whether children of this item should be copied.
1420
- * @param {boolean} bOverwrite Whether existing destination item shall be overwritten.
1421
- * @param {ITHit.WebDAV.Client.LockUriTokenPair[]} [oLockTokens] Lock tokens for destination folder.
1422
- * @param {ITHit.WebDAV.Client.HierarchyItem~CopyToAsyncCallback} fCallback Function to call when operation is completed.
1423
- */
1424
- 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;
1425
- /**
1426
- * Deletes this item.
1427
- * @api
1428
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Delete.Delete
1429
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Delete.Delete
1430
- * @param {ITHit.WebDAV.Client.LockUriTokenPair | null} oLockTokens Lock tokens for this item or any locked child item.
1431
- * @param {ITHit.WebDAV.Client.HierarchyItem~DeleteAsyncCallback} fCallback Function to call when operation is completed.
1432
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1433
- */
1434
- DeleteAsync(oLockTokens: ITHit.WebDAV.Client.LockUriTokenPair | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1435
- /**
1436
- * Returns names of all custom properties exposed by this item.
1437
- * @api
1438
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.GetProperties.GetPropertyNames
1439
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.GetProperties.GetPropertyNames
1440
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetPropertyNamesAsyncCallback} fCallback Function to call when operation is completed.
1441
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1442
- */
1443
- GetPropertyNamesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1444
- /**
1445
- * Retrieves values of specific properties.
1446
- * @api
1447
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.GetProperties.GetPropertyValues
1448
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.GetProperties.GetPropertyValues
1449
- * @param {ITHit.WebDAV.Client.PropertyName[]} aNames
1450
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetPropertyValuesAsyncCallback} fCallback Function to call when operation is completed.
1451
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1452
- */
1453
- GetPropertyValuesAsync(aNames: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1454
- /**
1455
- * Retrieves all custom properties exposed by the item.
1456
- * @api
1457
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.GetProperties.GetAllProperties
1458
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.GetProperties.GetAllProperties
1459
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetAllPropertiesAsyncCallback} fCallback Function to call when operation is completed.
1460
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1461
- */
1462
- GetAllPropertiesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1463
- /**
1464
- * Retrieves parent hierarchy item of this item.
1465
- * @api
1466
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.GetParent.GetParent
1467
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.GetParent.GetParent
1468
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
1469
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetParentAsyncCallback} fCallback Function to call when operation is completed.
1470
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1471
- */
1472
- GetParentAsync(aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1473
- /**
1474
- * Retrieves media type independent links.
1475
- * @api
1476
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetSourceAsyncCallback} fCallback Function to call when operation is completed.
1477
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1478
- */
1479
- GetSourceAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1480
- /**
1481
- * Locks the item. If the lock was successfully applied, the server will return a lock token. You will pass this
1482
- * lock token back to the server when updating and unlocking the item. The actual lock time applied by the server
1483
- * may be different from the one requested by the client.
1484
- * @api
1485
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.Lock.SetLock
1486
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.Lock.SetLock
1487
- * @param {string} sLockScope Scope of the lock. See LockScope Enumeration {@link ITHit.WebDAV.Client.LockScope}
1488
- * @param {boolean} bDeep Whether to lock entire subtree.
1489
- * @param {string} sOwner Owner of the lock.
1490
- * @param {number} iTimeout Timeout after which lock expires. Pass -1 to request an infinite timeout.
1491
- * @param {ITHit.WebDAV.Client.HierarchyItem~LockAsyncCallback} fCallback Function to call when operation is completed.
1492
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1493
- */
1494
- LockAsync(sLockScope: string, bDeep: boolean, sOwner: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1495
- /**
1496
- * Moves this item to another location.
1497
- * @api
1498
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.CopyMove.Move
1499
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.CopyMove.Move
1500
- * @param {ITHit.WebDAV.Client.Folder} oDestinationFolder Folder to move to.
1501
- * @param {string} sDestinationName Name to assign to moved item.
1502
- * @param {boolean} bOverwrite Whether existing destination item shall be overwritten.
1503
- * @param {(string|ITHit.WebDAV.Client.LockUriTokenPair[])} oLockTokens Lock tokens for item to be moved, for destination folder or file to be overwritten that are locked.
1504
- * @param {ITHit.WebDAV.Client.HierarchyItem~MoveToAsyncCallback} fCallback Function to call when operation is completed.
1505
- * @return {ITHit.WebDAV.Client.Request} Request object.
1506
- */
1507
- 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;
1508
- /**
1509
- * Prolongs the lock.
1510
- * @api
1511
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.RefreshLock.RefreshLock
1512
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.RefreshLock.RefreshLock
1513
- * @param {string} sLockToken Identifies lock to be prolonged.
1514
- * @param {number} iTimeout New timeout to set.
1515
- * @param {ITHit.WebDAV.Client.HierarchyItem~RefreshLockAsyncCallback} fCallback Function to call when operation is completed.
1516
- * @return {ITHit.WebDAV.Client.Request} Request object.
1517
- */
1518
- RefreshLockAsync(sLockToken: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1519
- /**
1520
- * Gets features supported by this item, such as WebDAV class support.
1521
- * @api
1522
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.SupportedFeatures.SupportedFeatures
1523
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.SupportedFeatures.SupportedFeatures
1524
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetSupportedFeaturesAsyncCallback} fCallback Function to call when operation is completed.
1525
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1526
- */
1527
- GetSupportedFeaturesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1528
- /**
1529
- * Removes the lock.
1530
- * @api
1531
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.Lock.SetUnLock
1532
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.Lock.SetUnLock
1533
- * @param {string} sLockToken Identifies lock to be prolonged.
1534
- * @param {ITHit.WebDAV.Client.HierarchyItem~UnlockAsyncCallback} fCallback Function to call when operation is completed.
1535
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1536
- */
1537
- UnlockAsync(sLockToken: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1538
- /**
1539
- * Updates values of properties exposed by this item.
1540
- * @api
1541
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.UpdateProperties.Update
1542
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.UpdateProperties.Delete
1543
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.UpdateProperties.Update
1544
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.UpdateProperties.Delete
1545
- * @param {ITHit.WebDAV.Client.Property[]} oPropertiesToAddOrUpdate Properties to be updated.
1546
- * @param {ITHit.WebDAV.Client.PropertyName[]} oPropertiesToDelete Names of properties to be removed from this item.
1547
- * @param {string} [sLockToken] Lock token.
1548
- * @param {ITHit.WebDAV.Client.HierarchyItem~UpdatePropertiesAsyncCallback} fCallback Function to call when operation is completed.
1549
- * @returns {ITHit.WebDAV.Client.WebDavRequest|null} WebDAV request
1550
- */
1551
- 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;
1552
- }/**
1553
- * The class represents set of extensions to be edited with Microsoft Office.
1554
- * @api
1555
- * @class ITHit.WebDAV.Client.MsOfficeEditExtensions
1556
- * @examplecode ITHit.WebDAV.Client.Tests.DocManager.MsOfficeEditExtensions.EditRtfDocumentWithWord
1557
- * @examplecode ITHit.WebDAV.Client.TSExamples.DocManager.MsOfficeEditExtensions.EditRtfDocumentWithWord
1558
- */
1559
- class MsOfficeEditExtensions {
1560
- /**
1561
- * Array of file extensions which are opened with Microsoft Access.
1562
- * @api
1563
- * @type {Array.<string>}
1564
- */
1565
- static Access: string[]
1566
- Access: string[]
1567
- /**
1568
- * Array of file extensions which are opened with Microsoft Infopath.
1569
- * @api
1570
- * @type {Array.<string>}
1571
- */
1572
- static Infopath: string[]
1573
- Infopath: string[]
1574
- /**
1575
- * Array of file extensions which are opened with Microsoft Excel.
1576
- * @api
1577
- * @type {Array.<string>}
1578
- */
1579
- static Excel: string[]
1580
- Excel: string[]
1581
- /**
1582
- * Array of file extensions which are opened with Microsoft Powerpoint.
1583
- * @api
1584
- * @type {Array.<string>}
1585
- */
1586
- static Powerpoint: string[]
1587
- Powerpoint: string[]
1588
- /**
1589
- * Array of file extensions which are opened with Microsoft Project.
1590
- * @api
1591
- * @type {Array.<string>}
1592
- */
1593
- static Project: string[]
1594
- Project: string[]
1595
- /**
1596
- * Array of file extensions which are opened with Microsoft Publisher.
1597
- * @api
1598
- * @type {Array.<string>}
1599
- */
1600
- static Publisher: string[]
1601
- Publisher: string[]
1602
- /**
1603
- * Array of file extensions which are opened with Microsoft Visio.
1604
- * @api
1605
- * @type {Array.<string>}
1606
- */
1607
- static Visio: string[]
1608
- Visio: string[]
1609
- /**
1610
- * Array of file extensions which are opened with Microsoft Word.
1611
- * @api
1612
- * @type {Array.<string>}
1613
- */
1614
- static Word: string[]
1615
- Word: string[]
1616
- }/**
1617
- * This class provides methods for opening documents for editing directly from server and saving back to server
1618
- * without download and upload steps. This includes editing Microsoft Office documents as well as any other file
1619
- * types and works on Windows, Mac OS X and Linux.
1620
- * @api
1621
- * @class ITHit.WebDAV.Client.DocManager
1622
- */
1623
- namespace DocManager{
1624
- /**
1625
- * Gets file names of the protocol installer depending on OS.
1626
- * @api
1627
- * @return {Array.<string>} An array with file names of the protocol installer.
1628
- */
1629
- function GetProtocolInstallFileNames(): string[];
1630
- /**
1631
- * Gets Uri of the protocol installer depending on OS.
1632
- * @api
1633
- * @return {string} Uri of the protocol installer.
1634
- */
1635
- function GetProtocolInstallUri(): string;
1636
- /**
1637
- * Returns true if protocol application installer is supported for the OS on which this function is called, false - otherwise.
1638
- * @api
1639
- * @return {boolean} True if protocol application installer is supported for the OS on which this function is called.
1640
- */
1641
- function IsDavProtocolSupported(): boolean;
1642
- /**
1643
- * <p>Mounts folder in file system and opens it in default OS file manger. Requests protocol installation if folder opening protocol is not installed.</p>
1644
- * <i class="optional">The following functionality is supported in v3 Beta and later only:</i>
1645
- * <p>
1646
- * This function supports both challenge-response authentication (Basic, Digest, NTLM, Kerberos) and cookies authentication.
1647
- * If <code>'None'</code> is specified in the <code>sSearchIn</code> parameter the challenge-response authentication is used, otherwise cookies authentication is used.
1648
- * </p>
1649
- * @api
1650
- * @param {string} sFolderUrl URL of the folder to open in OS file manager. Must be a full URL including the domain name.
1651
- * @param {string} [sMountUrl] URL to mount file system to before opening the folder. Usually this is your WebDAV server root folder. If this parameter is not specified file system will be mounted to the folder in which document is located.
1652
- * @param {function} [errorCallback] Function to call if file manager opening has failed. Typically you will request the protocol installation in this callback.
1653
- * If not specified a default message offering protocol installation will be displayed.
1654
- * @param {string} [reserved] Reserved for future use.
1655
- * @param {string} [sSearchIn] <span class="optional">v3 Beta and later only.</span> Indicates cookies authentication. Allowed values are:
1656
- * <ul>
1657
- * <li><code>'Current'</code> - Copies cookies from web browser in which this script is running.</li>
1658
- * <li><code>'None'</code> - do not search or copy any cookies.</li>
1659
- * </ul>
1660
- * Default is <code>'None'</code>.
1661
- * @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.
1662
- * @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.
1663
- */
1664
- function OpenFolderInOsFileManager(sFolderUrl: string, sMountUrl?: string | null, errorCallback?: Function | null, reserved?: string | null, sSearchIn?: string | null, sCookieNames?: string | null, sLoginUrl?: string | null): void;
1665
- /**
1666
- * Extracts extension and returns true if URL points to Microsoft Office Document.
1667
- * @api
1668
- * @param {string} sDocumentUrl URL of the document.
1669
- * @return {boolean} True if URL points to Microsoft Office Document.
1670
- */
1671
- function IsMicrosoftOfficeDocument(sDocumentUrl: string): boolean;
1672
- /**
1673
- * Opens Microsoft Office document using protocol. This method does not offer protocol installation if protocol is not found. Microsoft Office must be installed on a client machine.
1674
- * @api
1675
- * @param {string} sDocumentUrl URL of the document to edit. This must be a Microsoft Office document. Must be a full URL including the domain name.
1676
- */
1677
- function MicrosoftOfficeEditDocument(sDocumentUrl: string): void;
1678
- /**
1679
- * <p>Opens document for editing. In case of Microsoft Office documents, it will try to use Microsoft Office protocols first.
1680
- * If Microsoft Office protocols are not found it will use davX: protocol and prompt to install it if not found.</p>
1681
- * <p>This function supports only challenge-response authentication (Basic, Digest, NTLM, Kerberos).
1682
- * You can also use it to open MS Office documents from servers with MS-OFBA authentication.</p>
1683
- * <p>This function does <b>NOT</b> support cookies authentication. If your server is using cookies authentication use the <code>DavProtocolEditDocument()</code> function instead.</p>
1684
- * @example
1685
- * &lt;!DOCTYPE html&gt;
1686
- * &lt;html&gt;
1687
- * &lt;head&gt;
1688
- * &lt;meta charset="utf-8" /&gt;
1689
- * &lt;script type="text/javascript" src="ITHitWebDAVClient.js" &gt;&lt;/script&gt;
1690
- * &lt;/head&gt;
1691
-
1692
- * &lt;body&gt;
1693
- * &lt;script type="text/javascript"&gt;
1694
- * function edit() {
1695
- * ITHit.WebDAV.Client.DocManager.EditDocument("http://localhost:87654/folder/file.ext", "http://localhost:87654/", errorCallback);
1696
- * }
1697
- *
1698
- * function errorCallback() {
1699
- * var installerFilePath = "/Plugins/" + ITHit.WebDAV.Client.DocManager.GetProtocolInstallFileNames()[0];
1700
- *
1701
- * if (confirm("Opening this type of file requires a protocol installation. Select OK to download the protocol installer.")){
1702
- * window.open(installerFilePath);
1703
- * }
1704
- * }
1705
- * &lt;/script&gt;
1706
- * &lt;input type="button" value="Edit Document" onclick="edit()" /&gt;
1707
- * &lt;/body&gt;
1708
- * &lt;/html&gt;
1709
- * @api
1710
- * @param {string} sDocumentUrl URL of the document to open for editing from server. Must be a full URL including the domain name. Unlike <code>DavProtocolEditDocument()</code> function, this function supports only one document URL in this parameter.
1711
- * @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.
1712
- * @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.
1713
- * If not specified a default message offering protocol installation will be displayed.
1714
- */
1715
- function EditDocument(sDocumentUrl: string, sMountUrl?: string | null, errorCallback?: Function | null): void;
1716
- /**
1717
- * Extracts extension and returns true if the document can be edited in G Suite editor or document preview generated via G Suite.
1718
- * @api
1719
- * @param {string} sDocumentUrl URL of the document.
1720
- * @return {boolean} True if URL points to GSuite Editor.
1721
- */
1722
- function IsGSuiteDocument(sDocumentUrl: string): boolean;
1723
- /**
1724
- * <p>Edit MS Office document with G Suite Online Editor.</p>
1725
- * @api
1726
- * @param {string} sDocumentUrl URL of the document to open for editing from server. Must be a full URL including the domain name.
1727
- * @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.
1728
- * @param {function} [errorCallback] Function to call if document opening failed.
1729
- */
1730
- function GSuiteEditDocument(sDocumentUrl: string, oContainerDomElement: any, errorCallback?: Function | null): void;
1731
- /**
1732
- * <p>Preview MS Office document with G Suite Online Tool.</p>
1733
- * @api
1734
- * @param {string} sDocumentUrl URL of the document to open for preview. Must be a full URL including the domain name.
1735
- * @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.
1736
- * @param {function} [errorCallback] Function to call if document opening failed.
1737
- */
1738
- function GSuitePreviewDocument(sDocumentUrl: string, oContainerDomElement: any, errorCallback?: Function | null): void;
1739
- /**
1740
- * <p>Opens document for editing or printing using davX: protocol and prompts to install the protocol it if not found.</p>
1741
- * <i class="optional">The following functionality is supported in v3 Beta and later only:</i>
1742
- * <p>
1743
- * This function supports both challenge-response authentication (Basic, Digest, NTLM, Kerberos) and cookies authentication.
1744
- * If <code>'None'</code> is specified in the <code>sSearchIn</code> parameter the challenge-response authentication is used, otherwise cookies authentication is used.
1745
- * </p>
1746
- * @example
1747
- * &lt;!DOCTYPE html&gt;
1748
- * &lt;html&gt;
1749
- * &lt;head&gt;
1750
- * &lt;meta charset="utf-8" /&gt;
1751
- * &lt;script type="text/javascript" src="ITHitWebDAVClient.js" &gt;&lt;/script&gt;
1752
- * &lt;/head&gt;
1753
- * &lt;body&gt;
1754
- * &lt;script type="text/javascript"&gt;
1755
- * function edit() {
1756
- * ITHit.WebDAV.Client.DocManager.DavProtocolEditDocument(
1757
- * 'http://localhost:87654/folder/file.ext', // Document URL(s)
1758
- * 'http://localhost:87654/', // Mount URL
1759
- * errorCallback, // Function to call if protocol app is not installed
1760
- * null, // Reserved
1761
- * 'Current', // Which browser to copy cookies from: 'Current', 'None'
1762
- * '.AspNet.ApplicationCookie', // Cookie(s) to copy.
1763
- * '/Account/Login', // URL to navigate to if any cookie from the list is not found.
1764
- * 'Edit' // Command to execute: 'Edit', 'OpenWith', 'Print'
1765
- * );
1766
- * }
1767
- *
1768
- * function errorCallback() {
1769
- * var installerFilePath = "/Plugins/" + ITHit.WebDAV.Client.DocManager.GetProtocolInstallFileNames()[0];
1770
- *
1771
- * if (confirm("Opening this type of file requires a protocol installation. Select OK to download the protocol installer.")){
1772
- * window.open(installerFilePath);
1773
- * }
1774
- * }
1775
- * &lt;/script&gt;
1776
- * &lt;input type="button" value="Edit Document" onclick="edit()" /&gt;
1777
- * &lt;/body&gt;
1778
- * &lt;/html&gt;
1779
- * @api
1780
- * @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.
1781
- * @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.
1782
- * @param {function} [errorCallback] Function to call if document opening failed. Typically you will request the protocol installation in this callback.
1783
- * If not specified a default message offering protocol installation will be displayed.
1784
- * @param {string} [reserved] Reserved for future use.
1785
- * @param {string} [sSearchIn] <span class="optional">v3 Beta and later only.</span> Indicates cookies authentication. Supported options are:
1786
- * <ul>
1787
- * <li><code>'Current'</code> - Copies cookies from web browser in which this script is running.</li>
1788
- * <li><code>'None'</code> - do not search or copy any cookies.</li>
1789
- * </ul>
1790
- * Default is <code>'None'</code>.
1791
- * @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.
1792
- * @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.
1793
- * @param {string} [sCommand] <span class="optional">v3 Beta and later only.</span> Command to use when opening the document. Supported options are:
1794
- * <ul>
1795
- * <li> <code>null</code> - Chooses an appropriate verb to open a document in the associated application.
1796
- * <li> <code>'Edit'</code> - Opens a document for editing.
1797
- * <li> <code>'Open'</code> - Opens a document in the associated application. Not applicable for some applications.
1798
- * <li> <code>'OpenWith'</code> - Show system 'Open With' dialog to select application to be used to open a document. This option is supported on Windows only.
1799
- * <li> <code>'Print'</code> - Prints a document. The application that prints a document is running in a minimized state and automatically closes if printing is successful. If printing fails, the application remains open. To print multiple documents, pass a list of documents as a first parameter. This option is supported on Windows only.
1800
- * </ul>
1801
- * Default is <code>null</code>.
1802
- */
1803
- 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;
1804
- }class DocManager {
1805
- /**
1806
- * Collection of extensions of files which are opened with Microsoft Office.
1807
- * @api
1808
- * @type {ITHit.WebDAV.Client.MsOfficeEditExtensions}
1809
- * @examplecode ITHit.WebDAV.Client.Tests.DocManager.MsOfficeEditExtensions.EditDocumentTest
1810
- * @examplecode ITHit.WebDAV.Client.TSExamples.DocManager.MsOfficeEditExtensions.EditDocumentTest
1811
- */
1812
- static MsOfficeEditExtensions: ITHit.WebDAV.Client.MsOfficeEditExtensions
1813
- MsOfficeEditExtensions: ITHit.WebDAV.Client.MsOfficeEditExtensions
1814
- /**
1815
- * Timeout in milliseconds to call error callback if application associated with the extension did not start.
1816
- * Default is 3000ms.
1817
- * Used in Chrome / Internet Explorer / Safari if protocol application is not installed AND web browser protocol warning dialog is disabled AND EditDocument() / MicrosoftOfficeEditDocument() function is called (in case of Basic/Digest/Anonymous authentication).
1818
- * NOT used in Firefox / Edge OR if DavProtocolEditDocument() is called OR if web browser protocol warning dialog is enabled.
1819
- * @api
1820
- * @type {number}
1821
- */
1822
- static ProtocolTimeoutMs: number
1823
- ProtocolTimeoutMs: number
1824
- /**
1825
- * WebDAV protocol name.
1826
- * @api
1827
- * @type {string}
1828
- */
1829
- static ProtocolName: string
1830
- ProtocolName: string
1831
- }/**
1832
- * Provides support partial uploads and resuming broken uploads.
1833
- * @api
1834
- * @class ITHit.WebDAV.Client.ResumableUpload
1835
- */
1836
- class ResumableUpload {
1837
- /**
1838
- * Get amount of bytes successfully uploaded to server.
1839
- * @api
1840
- * @param {ITHit.WebDAV.Client.ResumableUpload~GetBytesUploadedAsyncCallback} fCallback Function to call when operation is completed.
1841
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1842
- */
1843
- GetBytesUploadedAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1844
- /**
1845
- * Cancels upload of the file.
1846
- * @api
1847
- * @param {string} mLockTokens Lock token for this file.
1848
- * @param {ITHit.WebDAV.Client.ResumableUpload~CancelUploadAsyncCallback} fCallback Function to call when operation is completed.
1849
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1850
- */
1851
- CancelUploadAsync(mLockTokens: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1852
- }/**
1853
- * Information about lock set on an item.
1854
- * @api
1855
- * @class ITHit.WebDAV.Client.GEditInfo
1856
- */
1857
- class GEditInfo {
1858
- /**
1859
- * File ID from google drive.
1860
- * @api
1861
- * @type {string}
1862
- */
1863
- GFileID: string
1864
- /**
1865
- * Revision ID from google drive.
1866
- * @api
1867
- * @type {string}
1868
- */
1869
- GRevisionID: string
1870
- }/**
1871
- * Represents a file on a WebDAV server.
1872
- * @api
1873
- * @class ITHit.WebDAV.Client.File
1874
- * @extends ITHit.WebDAV.Client.HierarchyItem
1875
- */
1876
- namespace File{
1877
- /**
1878
- * Locks the item and upload to google drive.
1879
- * @api
1880
- * @param {ITHit.WebDAV.Client.Request} oRequest Current WebDAV session.
1881
- * @param {string} sHref This item path on the server.
1882
- * @returns {ITHit.WebDAV.Client.GEditInfo} Instance of GEditInfo.
1883
- */
1884
- function GEdit(oRequest: ITHit.WebDAV.Client.Request, sHref: string): ITHit.WebDAV.Client.GEditInfo;
1885
- /**
1886
- * Locks the item and upload to google drive.
1887
- * @api
1888
- * @param {ITHit.WebDAV.Client.Request} oRequest Current WebDAV session.
1889
- * @param {string} sHref This item path on the server.
1890
- * @param {ITHit.WebDAV.Client.File~GEditAsyncCallback} fCallback Function to call when operation is completed.
1891
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1892
- */
1893
- function GEditAsync(oRequest: ITHit.WebDAV.Client.Request, sHref: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1894
- /**
1895
- * Removes the lock and update file.
1896
- * @api
1897
- * @param {ITHit.WebDAV.Client.Request} oRequest Current WebDAV session.
1898
- * @param {string} sHref This item path on the server.
1899
- * @param {string} [sLockToken] Identifies lock to be prolonged.
1900
- * @throws ITHit.WebDAV.Client.Exceptions.PreconditionFailedException The item is not locked.
1901
- * @throws ITHit.WebDAV.Client.Exceptions.NotFoundException The item doesn't exist on the server.
1902
- * @throws ITHit.WebDAV.Client.Exceptions.WebDavException Unexpected error occurred.
1903
- */
1904
- function GUnlock(oRequest: ITHit.WebDAV.Client.Request, sHref: string, sLockToken?: string | null): void;
1905
- /**
1906
- * Removes the lock and update file.
1907
- * @api
1908
- * @param {ITHit.WebDAV.Client.Request} oRequest Current WebDAV session.
1909
- * @param {string} sHref This item path on the server.
1910
- * @param {string} sLockToken Identifies lock to be prolonged.
1911
- * @param {string} sRevisionID Revision ID of google file.
1912
- * @param {ITHit.WebDAV.Client.File~GUnlockAsyncCallback} fCallback Function to call when operation is completed.
1913
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1914
- */
1915
- 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;
1916
- }class File extends ITHit.WebDAV.Client.HierarchyItem {
1917
- /**
1918
- * Length of the file.
1919
- * @api
1920
- * @type {number}
1921
- */
1922
- ContentLength: number
1923
- /**
1924
- * Content type of the file.
1925
- * @api
1926
- * @type {string}
1927
- */
1928
- ContentType: string
1929
- /**
1930
- * ResumableUpload instance to manage partially failed uploads.
1931
- * @api
1932
- * @type {ITHit.WebDAV.Client.ResumableUpload}
1933
- */
1934
- ResumableUpload: ITHit.WebDAV.Client.ResumableUpload
1935
- /**
1936
- * Reads file content. To download only a part of a file you can specify 2 parameters in ReadContent call.
1937
- * First parameter is the starting byte (zero-based) at witch to start content download, the second – amount
1938
- * of bytes to be downloaded. The library will add Range header to the request in this case.
1939
- * @api
1940
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.CreateFile.ReadContent
1941
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.CreateFile.ReadContentRange
1942
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.CreateFile.ReadContent
1943
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.CreateFile.ReadContentRange
1944
- * @param {number} iBytesFrom Start position to retrieve lBytesCount number of bytes from.
1945
- * @param {number} iBytesCount Number of bytes to retrieve.
1946
- * @param {ITHit.WebDAV.Client.File~ReadContentAsyncCallback} fCallback Function to call when operation is completed.
1947
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1948
- */
1949
- ReadContentAsync(iBytesFrom: number, iBytesCount: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1950
- /**
1951
- * Writes file content.
1952
- * @api
1953
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.CreateFile.OnlyWriteContent
1954
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.CreateFile.OnlyWriteContent
1955
- * @param {string} sContent File content.
1956
- * @param {string} sLockToken Lock token.
1957
- * @param {string} sMimeType File mime-type.
1958
- * @param {ITHit.WebDAV.Client.File~WriteContentAsyncCallback} fCallback Function to call when operation is completed.
1959
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1960
- */
1961
- WriteContentAsync(sContent: string, sLockToken: string, sMimeType: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1962
- /**
1963
- * Retrieves item versions.
1964
- * @examplecode ITHit.WebDAV.Client.Tests.Versions.GetVersions.GetVersions
1965
- * @examplecode ITHit.WebDAV.Client.TSExamples.Versions.GetVersions.GetVersions
1966
- * @api
1967
- * @param {ITHit.WebDAV.Client.File~GetVersionsAsyncCallback} fCallback Function to call when operation is completed.
1968
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1969
- */
1970
- GetVersionsAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1971
- /**
1972
- * Update to version.
1973
- * @examplecode ITHit.WebDAV.Client.Tests.Versions.ManageVersions.UpdateToVersion
1974
- * @examplecode ITHit.WebDAV.Client.TSExamples.Versions.ManageVersions.UpdateToVersion
1975
- * @api
1976
- * @param {string|ITHit.WebDAV.Client.Version} mVersion Href to file with version attribute or {@link ITHit.WebDAV.Client.Version} instance.
1977
- * @param {ITHit.WebDAV.Client.File~UpdateToVersionAsyncCallback} fCallback Function to call when operation is completed.
1978
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1979
- */
1980
- UpdateToVersionAsync(mVersion: string | ITHit.WebDAV.Client.Version, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1981
- /**
1982
- * Enables / disables version control for this file.
1983
- * @api
1984
- * @examplecode ITHit.WebDAV.Client.Tests.Versions.PutUnderVersion.EnableVersion
1985
- * @examplecode ITHit.WebDAV.Client.TSExamples.Versions.PutUnderVersion.EnableVersion
1986
- * @param {boolean} bEnable True to enable version-control, false - to disable.
1987
- * @param {string} mLockToken Lock token for this item.
1988
- * @param {ITHit.WebDAV.Client.File~PutUnderVersionControlAsyncCallback} fCallback Function to call when operation is completed.
1989
- * @returns {ITHit.WebDAV.Client.Request} Request object.
1990
- */
1991
- PutUnderVersionControlAsync(bEnable: boolean, mLockToken: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
1992
- /**
1993
- * Current WebDAV session.
1994
- * @api
1995
- * @type {ITHit.WebDAV.Client.WebDavSession}
1996
- */
1997
- Session: ITHit.WebDAV.Client.WebDavSession
1998
- /**
1999
- * This item path on the server.
2000
- * @api
2001
- * @type {string}
2002
- */
2003
- Href: string
2004
- /**
2005
- * Most recent modification date.
2006
- * @api
2007
- * @type {Date}
2008
- */
2009
- LastModified: Date
2010
- /**
2011
- * User friendly item name.
2012
- * @api
2013
- * @type {string}
2014
- */
2015
- DisplayName: string
2016
- /**
2017
- * The date item was created.
2018
- * @api
2019
- * @type {Date}
2020
- */
2021
- CreationDate: Date
2022
- /**
2023
- * Type of the item (File or Folder).
2024
- * @api
2025
- * @type {string}
2026
- * @see ITHit.WebDAV.Client.ResourceType
2027
- */
2028
- ResourceType: string
2029
- /**
2030
- * Retrieves information about supported locks. Item can support exclusive, shared locks or do not support
2031
- * any locks. If you set exclusive lock other users will not be able to set any locks. If you set shared
2032
- * lock other users will be able to set shared lock on the item.
2033
- * @api
2034
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.CheckSupport.CheckLockSupport
2035
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.CheckSupport.CheckLockSupport
2036
- * @type {Array.<string>}
2037
- * @see ITHit.WebDAV.Client.LockScope
2038
- */
2039
- SupportedLocks: string[]
2040
- /**
2041
- * List of locks applied to this item.
2042
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.GetLocks.GetList
2043
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.GetLocks.GetList
2044
- * @api
2045
- * @type {Array.<ITHit.WebDAV.Client.LockInfo>}
2046
- */
2047
- ActiveLocks: ITHit.WebDAV.Client.LockInfo[]
2048
- /**
2049
- * List of item properties.
2050
- * @api
2051
- * @type {ITHit.WebDAV.Client.PropertyList}
2052
- */
2053
- Properties: ITHit.WebDAV.Client.PropertyList
2054
- /**
2055
- * Returns true if file is under version control. Otherwise false. To detect if version control could
2056
- * be enabled for this item call GetSupportedFeaturesAsync and check for VersionControl token.
2057
- * To enable version control call PutUnderVersionControlAsync.
2058
- * @api
2059
- * @returns {boolean} Boolean, if true - versions supported
2060
- */
2061
- /**
2062
- * Number of bytes available for this user on server. -1 if server does not support Quota.
2063
- * @api
2064
- * @type {number}
2065
- */
2066
- AvailableBytes: number
2067
- /**
2068
- * Number of bytes used by this user on server. -1 if server does not support Quota.
2069
- * @api
2070
- * @type {number}
2071
- */
2072
- UsedBytes: number
2073
- /**
2074
- * Refreshes item loading data from server.
2075
- * @api
2076
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Refresh.Refresh
2077
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Refresh.Refresh
2078
- * @param {ITHit.WebDAV.Client.HierarchyItem~RefreshAsyncCallback} fCallback Function to call when operation is completed.
2079
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2080
- */
2081
- RefreshAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2082
- /**
2083
- * Copies this item to destination folder.
2084
- * @api
2085
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.CopyMove.Copy
2086
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.CopyMove.Copy
2087
- * @param {ITHit.WebDAV.Client.Folder} oDestinationFolder Folder to move to.
2088
- * @param {string} sDestinationName Name to assign to copied item.
2089
- * @param {boolean} bDeep Indicates whether children of this item should be copied.
2090
- * @param {boolean} bOverwrite Whether existing destination item shall be overwritten.
2091
- * @param {ITHit.WebDAV.Client.LockUriTokenPair[]} [oLockTokens] Lock tokens for destination folder.
2092
- * @param {ITHit.WebDAV.Client.HierarchyItem~CopyToAsyncCallback} fCallback Function to call when operation is completed.
2093
- */
2094
- 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;
2095
- /**
2096
- * Deletes this item.
2097
- * @api
2098
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Delete.Delete
2099
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Delete.Delete
2100
- * @param {ITHit.WebDAV.Client.LockUriTokenPair | null} oLockTokens Lock tokens for this item or any locked child item.
2101
- * @param {ITHit.WebDAV.Client.HierarchyItem~DeleteAsyncCallback} fCallback Function to call when operation is completed.
2102
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2103
- */
2104
- DeleteAsync(oLockTokens: ITHit.WebDAV.Client.LockUriTokenPair | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2105
- /**
2106
- * Returns names of all custom properties exposed by this item.
2107
- * @api
2108
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.GetProperties.GetPropertyNames
2109
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.GetProperties.GetPropertyNames
2110
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetPropertyNamesAsyncCallback} fCallback Function to call when operation is completed.
2111
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2112
- */
2113
- GetPropertyNamesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2114
- /**
2115
- * Retrieves values of specific properties.
2116
- * @api
2117
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.GetProperties.GetPropertyValues
2118
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.GetProperties.GetPropertyValues
2119
- * @param {ITHit.WebDAV.Client.PropertyName[]} aNames
2120
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetPropertyValuesAsyncCallback} fCallback Function to call when operation is completed.
2121
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2122
- */
2123
- GetPropertyValuesAsync(aNames: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2124
- /**
2125
- * Retrieves all custom properties exposed by the item.
2126
- * @api
2127
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.GetProperties.GetAllProperties
2128
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.GetProperties.GetAllProperties
2129
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetAllPropertiesAsyncCallback} fCallback Function to call when operation is completed.
2130
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2131
- */
2132
- GetAllPropertiesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2133
- /**
2134
- * Retrieves parent hierarchy item of this item.
2135
- * @api
2136
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.GetParent.GetParent
2137
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.GetParent.GetParent
2138
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
2139
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetParentAsyncCallback} fCallback Function to call when operation is completed.
2140
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2141
- */
2142
- GetParentAsync(aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2143
- /**
2144
- * Retrieves media type independent links.
2145
- * @api
2146
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetSourceAsyncCallback} fCallback Function to call when operation is completed.
2147
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2148
- */
2149
- GetSourceAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2150
- /**
2151
- * Locks the item. If the lock was successfully applied, the server will return a lock token. You will pass this
2152
- * lock token back to the server when updating and unlocking the item. The actual lock time applied by the server
2153
- * may be different from the one requested by the client.
2154
- * @api
2155
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.Lock.SetLock
2156
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.Lock.SetLock
2157
- * @param {string} sLockScope Scope of the lock. See LockScope Enumeration {@link ITHit.WebDAV.Client.LockScope}
2158
- * @param {boolean} bDeep Whether to lock entire subtree.
2159
- * @param {string} sOwner Owner of the lock.
2160
- * @param {number} iTimeout Timeout after which lock expires. Pass -1 to request an infinite timeout.
2161
- * @param {ITHit.WebDAV.Client.HierarchyItem~LockAsyncCallback} fCallback Function to call when operation is completed.
2162
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2163
- */
2164
- LockAsync(sLockScope: string, bDeep: boolean, sOwner: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2165
- /**
2166
- * Moves this item to another location.
2167
- * @api
2168
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.CopyMove.Move
2169
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.CopyMove.Move
2170
- * @param {ITHit.WebDAV.Client.Folder} oDestinationFolder Folder to move to.
2171
- * @param {string} sDestinationName Name to assign to moved item.
2172
- * @param {boolean} bOverwrite Whether existing destination item shall be overwritten.
2173
- * @param {(string|ITHit.WebDAV.Client.LockUriTokenPair[])} oLockTokens Lock tokens for item to be moved, for destination folder or file to be overwritten that are locked.
2174
- * @param {ITHit.WebDAV.Client.HierarchyItem~MoveToAsyncCallback} fCallback Function to call when operation is completed.
2175
- * @return {ITHit.WebDAV.Client.Request} Request object.
2176
- */
2177
- 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;
2178
- /**
2179
- * Prolongs the lock.
2180
- * @api
2181
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.RefreshLock.RefreshLock
2182
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.RefreshLock.RefreshLock
2183
- * @param {string} sLockToken Identifies lock to be prolonged.
2184
- * @param {number} iTimeout New timeout to set.
2185
- * @param {ITHit.WebDAV.Client.HierarchyItem~RefreshLockAsyncCallback} fCallback Function to call when operation is completed.
2186
- * @return {ITHit.WebDAV.Client.Request} Request object.
2187
- */
2188
- RefreshLockAsync(sLockToken: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2189
- /**
2190
- * Gets features supported by this item, such as WebDAV class support.
2191
- * @api
2192
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.SupportedFeatures.SupportedFeatures
2193
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.SupportedFeatures.SupportedFeatures
2194
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetSupportedFeaturesAsyncCallback} fCallback Function to call when operation is completed.
2195
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2196
- */
2197
- GetSupportedFeaturesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2198
- /**
2199
- * Removes the lock.
2200
- * @api
2201
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.Lock.SetUnLock
2202
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.Lock.SetUnLock
2203
- * @param {string} sLockToken Identifies lock to be prolonged.
2204
- * @param {ITHit.WebDAV.Client.HierarchyItem~UnlockAsyncCallback} fCallback Function to call when operation is completed.
2205
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2206
- */
2207
- UnlockAsync(sLockToken: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2208
- /**
2209
- * Updates values of properties exposed by this item.
2210
- * @api
2211
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.UpdateProperties.Update
2212
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.UpdateProperties.Delete
2213
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.UpdateProperties.Update
2214
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.UpdateProperties.Delete
2215
- * @param {ITHit.WebDAV.Client.Property[]} oPropertiesToAddOrUpdate Properties to be updated.
2216
- * @param {ITHit.WebDAV.Client.PropertyName[]} oPropertiesToDelete Names of properties to be removed from this item.
2217
- * @param {string} [sLockToken] Lock token.
2218
- * @param {ITHit.WebDAV.Client.HierarchyItem~UpdatePropertiesAsyncCallback} fCallback Function to call when operation is completed.
2219
- * @returns {ITHit.WebDAV.Client.WebDavRequest|null} WebDAV request
2220
- */
2221
- 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;
2222
- }/**
2223
- * @classdesc Represents a search request.
2224
- * @constructs
2225
- * @api
2226
- * @param {string} sSearchPhrase Search phrase.
2227
- */
2228
- class SearchQuery {
2229
- constructor(sSearchPhrase: string);
2230
- /**
2231
- * Search phrase.
2232
- * @api
2233
- * @type {string}
2234
- */
2235
- Phrase: string
2236
- /**
2237
- * <p>Properties to be returned from server with each item returned in search results.</p>
2238
- * <p>This property can be used to request any additional data required in search results, such as snippet of
2239
- * text around the search phrase, document title, author name, etc.</p>
2240
- * @api
2241
- * @type {ITHit.WebDAV.Client.PropertyName[]}
2242
- */
2243
- SelectProperties: ITHit.WebDAV.Client.PropertyName[]
2244
- /**
2245
- * Enables or disables search by properties specified in <code>LikeProperties</code> list. Default is <code>true</code>.
2246
- * @api
2247
- * @type {boolean}
2248
- */
2249
- EnableLike: boolean
2250
- /**
2251
- * List of properties to be used in like conditions. The search phrase will be searched in the properties specilied in this list.
2252
- * @api
2253
- * @type {ITHit.WebDAV.Client.PropertyName[]}
2254
- */
2255
- LikeProperties: ITHit.WebDAV.Client.PropertyName[]
2256
- /**
2257
- * Enables or disables search inside file content. Default is <code>true</code>.
2258
- * @api
2259
- * @type {boolean}
2260
- */
2261
- EnableContains: boolean
2262
- }/**
2263
- * Array of file and folder items that correspond to the offset, number of items and sorting conditions requested from server.
2264
- * Also contains a total number of items in this folder or in search results.
2265
- * @api
2266
- * @class ITHit.WebDAV.Client.PageResults
2267
- */
2268
- class PageResults {
2269
- /**
2270
- * Total number of items in the folder or in search results.
2271
- * @api
2272
- * @type {number}
2273
- */
2274
- TotalItems: number
2275
- /**
2276
- * Items that correspond to the requested page and sorting.
2277
- * @api
2278
- * @type {ITHit.WebDAV.Client.HierarchyItem[]}
2279
- */
2280
- Page: ITHit.WebDAV.Client.HierarchyItem[]
2281
- }/**
2282
- * Represents a folder in a WebDAV repository.
2283
- * @api
2284
- * @class ITHit.WebDAV.Client.Folder
2285
- * @extends ITHit.WebDAV.Client.HierarchyItem
2286
- */
2287
- class Folder extends ITHit.WebDAV.Client.HierarchyItem {
2288
- /**
2289
- * Creates a new folder with a specified name as child of this folder.
2290
- * @api
2291
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.CreateFolder.CreateFolder
2292
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.CreateFolder.CreateFolder
2293
- * @param {string} sName Name of the new folder.
2294
- * @param {string} [sLockTokens] Lock token for ITHit.WebDAV.Client.Folder folder.
2295
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
2296
- * @param {ITHit.WebDAV.Client.Folder~CreateFolderAsyncCallback} fCallback Function to call when operation is completed.
2297
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2298
- */
2299
- CreateFolderAsync(sName: string, sLockTokens?: string | null, aProperties?: ITHit.WebDAV.Client.PropertyName[] | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2300
- /**
2301
- * Creates a new file with a specified name as a child of this folder.
2302
- * @api
2303
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.CreateFile.CreateAndWriteContent
2304
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.CreateFile.CreateAndWriteContent
2305
- * @param {string} sName Name of the new file.
2306
- * @param {string} sLockTokens Lock token for current folder.
2307
- * @param {string} sContent File content.
2308
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
2309
- * @param {ITHit.WebDAV.Client.Folder~CreateFileAsyncCallback} fCallback Function to call when operation is completed.
2310
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2311
- */
2312
- CreateFileAsync(sName: string, sLockTokens: string, sContent: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2313
- /**
2314
- * Gets specified number of children of this folder that correspond to requested offset and sorting. Use GetSupportedFeaturesAsync() function to detect if paging is supported.
2315
- * @api
2316
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.GetFolderItems.GetPage
2317
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.GetFolderItems.GetPage
2318
- * @param {ITHit.WebDAV.Client.PropertyName[]} [aProperties] Additional properties requested from server. If null is specified, only default properties are returned.
2319
- * @param {number} [nOffset] The number of items to skip before returning the remaining items.
2320
- * @param {number} [nResults] The number of items to return.
2321
- * @param {ITHit.WebDAV.Client.OrderProperty[]} [aOrderProperties] List of order properties.
2322
- * @param {ITHit.WebDAV.Client.Folder~GetPageAsyncCallback} fCallback Function to call when operation is completed.
2323
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2324
- */
2325
- 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;
2326
- /**
2327
- * 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.
2328
- * @api
2329
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.GetFolderItems.GetChildren
2330
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.GetFolderItems.GetChildren
2331
- * @param {boolean} bRecursively Indicates if all subtree of children should be return. Default is false.
2332
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. If null is specified, only default properties are returned.
2333
- * @param {ITHit.WebDAV.Client.Folder~GetChildrenAsyncCallback} fCallback Function to call when operation is completed.
2334
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2335
- */
2336
- GetChildrenAsync(bRecursively: boolean, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2337
- /**
2338
- * Gets the specified folder from server.
2339
- * @api
2340
- * @param {string} sName Name of the folder.
2341
- * @param {ITHit.WebDAV.Client.Folder~GetFolderAsyncCallback} fCallback Function to call when operation is completed.
2342
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2343
- */
2344
- GetFolderAsync(sName: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2345
- /**
2346
- * Gets the specified file from server.
2347
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.GetItemByFolder.GetFile
2348
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.GetItemByFolder.GetFile
2349
- * @api
2350
- * @param {string} sName Name of the file.
2351
- * @param {ITHit.WebDAV.Client.Folder~GetFileAsyncCallback} fCallback Function to call when operation is completed.
2352
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2353
- */
2354
- GetFileAsync(sName: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2355
- /**
2356
- * Gets the specified item from server.
2357
- * @api
2358
- * @param {string} sName Name of the item.
2359
- * @param {ITHit.WebDAV.Client.Folder~GetItemAsyncCallback} fCallback Function to call when operation is completed.
2360
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2361
- */
2362
- GetItemAsync(sName: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2363
- /**
2364
- * Checks whether specified item exists in the folder.
2365
- * @api
2366
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.ItemExists.ItemExists
2367
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.ItemExists.ItemExists
2368
- * @param {string} sName Name of the item.
2369
- * @param {ITHit.WebDAV.Client.Folder~ItemExistsAsyncCallback} fCallback Function to call when operation is completed.
2370
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2371
- */
2372
- ItemExistsAsync(sName: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2373
- /**
2374
- * 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.
2375
- * @api
2376
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Search.SearchByQuery
2377
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Search.SearchByQuery
2378
- * @param {ITHit.WebDAV.Client.SearchQuery} oSearchQuery Object with search query conditions.
2379
- * @param {ITHit.WebDAV.Client.Folder~SearchByQueryAsyncCallback} fCallback Function to call when operation is completed.
2380
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2381
- */
2382
- SearchByQueryAsync(oSearchQuery: ITHit.WebDAV.Client.SearchQuery, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2383
- /**
2384
- * 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.
2385
- * @api
2386
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Search.GetSearchPageByQuery
2387
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Search.GetSearchPageByQuery
2388
- * @param {ITHit.WebDAV.Client.SearchQuery} oSearchQuery Object with search query conditions.
2389
- * @param {number} [nOffset] The number of items to skip before returning the remaining items.
2390
- * @param {number} [nResults] The number of items to return.
2391
- * @param {ITHit.WebDAV.Client.Folder~GetSearchPageByQueryAsyncCallback} fCallback Function to call when operation is completed.
2392
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2393
- */
2394
- GetSearchPageByQueryAsync(oSearchQuery: ITHit.WebDAV.Client.SearchQuery, nOffset?: number | null, nResults?: number | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2395
- /**
2396
- * 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.
2397
- * @api
2398
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Search.SearchByString
2399
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Search.SearchByString
2400
- * @param {string} sSearchQuery String of search query.
2401
- * @param {ITHit.WebDAV.Client.PropertyName[]} [aProperties] Additional properties requested from server. If null is specified, only default properties are returned.
2402
- * @param {ITHit.WebDAV.Client.Folder~SearchAsyncCallback} fCallback Function to call when operation is completed.
2403
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2404
- */
2405
- SearchAsync(sSearchQuery: string, aProperties?: ITHit.WebDAV.Client.PropertyName[] | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2406
- /**
2407
- * 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.
2408
- * @api
2409
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Search.GetSearchPageByString
2410
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Search.GetSearchPageByString
2411
- * @param {string} sSearchQuery String of search query.
2412
- * @param {ITHit.WebDAV.Client.PropertyName[]} [aProperties] Additional properties requested from server. If null is specified, only default properties are returned.
2413
- * @param {number} [nOffset] The number of items to skip before returning the remaining items.
2414
- * @param {number} [nResults] The number of items to return.
2415
- * @param {ITHit.WebDAV.Client.Folder~GetSearchPageAsyncCallback} fCallback Function to call when operation is completed.
2416
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2417
- */
2418
- 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;
2419
- /**
2420
- * Current WebDAV session.
2421
- * @api
2422
- * @type {ITHit.WebDAV.Client.WebDavSession}
2423
- */
2424
- Session: ITHit.WebDAV.Client.WebDavSession
2425
- /**
2426
- * This item path on the server.
2427
- * @api
2428
- * @type {string}
2429
- */
2430
- Href: string
2431
- /**
2432
- * Most recent modification date.
2433
- * @api
2434
- * @type {Date}
2435
- */
2436
- LastModified: Date
2437
- /**
2438
- * User friendly item name.
2439
- * @api
2440
- * @type {string}
2441
- */
2442
- DisplayName: string
2443
- /**
2444
- * The date item was created.
2445
- * @api
2446
- * @type {Date}
2447
- */
2448
- CreationDate: Date
2449
- /**
2450
- * Type of the item (File or Folder).
2451
- * @api
2452
- * @type {string}
2453
- * @see ITHit.WebDAV.Client.ResourceType
2454
- */
2455
- ResourceType: string
2456
- /**
2457
- * Retrieves information about supported locks. Item can support exclusive, shared locks or do not support
2458
- * any locks. If you set exclusive lock other users will not be able to set any locks. If you set shared
2459
- * lock other users will be able to set shared lock on the item.
2460
- * @api
2461
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.CheckSupport.CheckLockSupport
2462
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.CheckSupport.CheckLockSupport
2463
- * @type {Array.<string>}
2464
- * @see ITHit.WebDAV.Client.LockScope
2465
- */
2466
- SupportedLocks: string[]
2467
- /**
2468
- * List of locks applied to this item.
2469
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.GetLocks.GetList
2470
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.GetLocks.GetList
2471
- * @api
2472
- * @type {Array.<ITHit.WebDAV.Client.LockInfo>}
2473
- */
2474
- ActiveLocks: ITHit.WebDAV.Client.LockInfo[]
2475
- /**
2476
- * List of item properties.
2477
- * @api
2478
- * @type {ITHit.WebDAV.Client.PropertyList}
2479
- */
2480
- Properties: ITHit.WebDAV.Client.PropertyList
2481
- /**
2482
- * Returns true if file is under version control. Otherwise false. To detect if version control could
2483
- * be enabled for this item call GetSupportedFeaturesAsync and check for VersionControl token.
2484
- * To enable version control call PutUnderVersionControlAsync.
2485
- * @api
2486
- * @returns {boolean} Boolean, if true - versions supported
2487
- */
2488
- /**
2489
- * Number of bytes available for this user on server. -1 if server does not support Quota.
2490
- * @api
2491
- * @type {number}
2492
- */
2493
- AvailableBytes: number
2494
- /**
2495
- * Number of bytes used by this user on server. -1 if server does not support Quota.
2496
- * @api
2497
- * @type {number}
2498
- */
2499
- UsedBytes: number
2500
- /**
2501
- * Refreshes item loading data from server.
2502
- * @api
2503
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Refresh.Refresh
2504
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Refresh.Refresh
2505
- * @param {ITHit.WebDAV.Client.HierarchyItem~RefreshAsyncCallback} fCallback Function to call when operation is completed.
2506
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2507
- */
2508
- RefreshAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2509
- /**
2510
- * Copies this item to destination folder.
2511
- * @api
2512
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.CopyMove.Copy
2513
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.CopyMove.Copy
2514
- * @param {ITHit.WebDAV.Client.Folder} oDestinationFolder Folder to move to.
2515
- * @param {string} sDestinationName Name to assign to copied item.
2516
- * @param {boolean} bDeep Indicates whether children of this item should be copied.
2517
- * @param {boolean} bOverwrite Whether existing destination item shall be overwritten.
2518
- * @param {ITHit.WebDAV.Client.LockUriTokenPair[]} [oLockTokens] Lock tokens for destination folder.
2519
- * @param {ITHit.WebDAV.Client.HierarchyItem~CopyToAsyncCallback} fCallback Function to call when operation is completed.
2520
- */
2521
- 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;
2522
- /**
2523
- * Deletes this item.
2524
- * @api
2525
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Delete.Delete
2526
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Delete.Delete
2527
- * @param {ITHit.WebDAV.Client.LockUriTokenPair | null} oLockTokens Lock tokens for this item or any locked child item.
2528
- * @param {ITHit.WebDAV.Client.HierarchyItem~DeleteAsyncCallback} fCallback Function to call when operation is completed.
2529
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2530
- */
2531
- DeleteAsync(oLockTokens: ITHit.WebDAV.Client.LockUriTokenPair | null, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2532
- /**
2533
- * Returns names of all custom properties exposed by this item.
2534
- * @api
2535
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.GetProperties.GetPropertyNames
2536
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.GetProperties.GetPropertyNames
2537
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetPropertyNamesAsyncCallback} fCallback Function to call when operation is completed.
2538
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2539
- */
2540
- GetPropertyNamesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2541
- /**
2542
- * Retrieves values of specific properties.
2543
- * @api
2544
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.GetProperties.GetPropertyValues
2545
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.GetProperties.GetPropertyValues
2546
- * @param {ITHit.WebDAV.Client.PropertyName[]} aNames
2547
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetPropertyValuesAsyncCallback} fCallback Function to call when operation is completed.
2548
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2549
- */
2550
- GetPropertyValuesAsync(aNames: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2551
- /**
2552
- * Retrieves all custom properties exposed by the item.
2553
- * @api
2554
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.GetProperties.GetAllProperties
2555
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.GetProperties.GetAllProperties
2556
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetAllPropertiesAsyncCallback} fCallback Function to call when operation is completed.
2557
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2558
- */
2559
- GetAllPropertiesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2560
- /**
2561
- * Retrieves parent hierarchy item of this item.
2562
- * @api
2563
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.GetParent.GetParent
2564
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.GetParent.GetParent
2565
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
2566
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetParentAsyncCallback} fCallback Function to call when operation is completed.
2567
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2568
- */
2569
- GetParentAsync(aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2570
- /**
2571
- * Retrieves media type independent links.
2572
- * @api
2573
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetSourceAsyncCallback} fCallback Function to call when operation is completed.
2574
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2575
- */
2576
- GetSourceAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2577
- /**
2578
- * Locks the item. If the lock was successfully applied, the server will return a lock token. You will pass this
2579
- * lock token back to the server when updating and unlocking the item. The actual lock time applied by the server
2580
- * may be different from the one requested by the client.
2581
- * @api
2582
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.Lock.SetLock
2583
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.Lock.SetLock
2584
- * @param {string} sLockScope Scope of the lock. See LockScope Enumeration {@link ITHit.WebDAV.Client.LockScope}
2585
- * @param {boolean} bDeep Whether to lock entire subtree.
2586
- * @param {string} sOwner Owner of the lock.
2587
- * @param {number} iTimeout Timeout after which lock expires. Pass -1 to request an infinite timeout.
2588
- * @param {ITHit.WebDAV.Client.HierarchyItem~LockAsyncCallback} fCallback Function to call when operation is completed.
2589
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2590
- */
2591
- LockAsync(sLockScope: string, bDeep: boolean, sOwner: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2592
- /**
2593
- * Moves this item to another location.
2594
- * @api
2595
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.CopyMove.Move
2596
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.CopyMove.Move
2597
- * @param {ITHit.WebDAV.Client.Folder} oDestinationFolder Folder to move to.
2598
- * @param {string} sDestinationName Name to assign to moved item.
2599
- * @param {boolean} bOverwrite Whether existing destination item shall be overwritten.
2600
- * @param {(string|ITHit.WebDAV.Client.LockUriTokenPair[])} oLockTokens Lock tokens for item to be moved, for destination folder or file to be overwritten that are locked.
2601
- * @param {ITHit.WebDAV.Client.HierarchyItem~MoveToAsyncCallback} fCallback Function to call when operation is completed.
2602
- * @return {ITHit.WebDAV.Client.Request} Request object.
2603
- */
2604
- 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;
2605
- /**
2606
- * Prolongs the lock.
2607
- * @api
2608
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.RefreshLock.RefreshLock
2609
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.RefreshLock.RefreshLock
2610
- * @param {string} sLockToken Identifies lock to be prolonged.
2611
- * @param {number} iTimeout New timeout to set.
2612
- * @param {ITHit.WebDAV.Client.HierarchyItem~RefreshLockAsyncCallback} fCallback Function to call when operation is completed.
2613
- * @return {ITHit.WebDAV.Client.Request} Request object.
2614
- */
2615
- RefreshLockAsync(sLockToken: string, iTimeout: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2616
- /**
2617
- * Gets features supported by this item, such as WebDAV class support.
2618
- * @api
2619
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.SupportedFeatures.SupportedFeatures
2620
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.SupportedFeatures.SupportedFeatures
2621
- * @param {ITHit.WebDAV.Client.HierarchyItem~GetSupportedFeaturesAsyncCallback} fCallback Function to call when operation is completed.
2622
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2623
- */
2624
- GetSupportedFeaturesAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2625
- /**
2626
- * Removes the lock.
2627
- * @api
2628
- * @examplecode ITHit.WebDAV.Client.Tests.Locks.Lock.SetUnLock
2629
- * @examplecode ITHit.WebDAV.Client.TSExamples.Locks.Lock.SetUnLock
2630
- * @param {string} sLockToken Identifies lock to be prolonged.
2631
- * @param {ITHit.WebDAV.Client.HierarchyItem~UnlockAsyncCallback} fCallback Function to call when operation is completed.
2632
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2633
- */
2634
- UnlockAsync(sLockToken: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2635
- /**
2636
- * Updates values of properties exposed by this item.
2637
- * @api
2638
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.UpdateProperties.Update
2639
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyProperties.UpdateProperties.Delete
2640
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.UpdateProperties.Update
2641
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyProperties.UpdateProperties.Delete
2642
- * @param {ITHit.WebDAV.Client.Property[]} oPropertiesToAddOrUpdate Properties to be updated.
2643
- * @param {ITHit.WebDAV.Client.PropertyName[]} oPropertiesToDelete Names of properties to be removed from this item.
2644
- * @param {string} [sLockToken] Lock token.
2645
- * @param {ITHit.WebDAV.Client.HierarchyItem~UpdatePropertiesAsyncCallback} fCallback Function to call when operation is completed.
2646
- * @returns {ITHit.WebDAV.Client.WebDavRequest|null} WebDAV request
2647
- */
2648
- 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;
2649
- }/**
2650
- * Represents a version on a WebDAV server.
2651
- * @api
2652
- * @class ITHit.WebDAV.Client.Version
2653
- * @extends ITHit.WebDAV.Client.File
2654
- */
2655
- class Version extends ITHit.WebDAV.Client.File {
2656
- /**
2657
- * This property contains a server-defined string that is different for each version.
2658
- * This string is intended for display for a user.
2659
- * @api
2660
- * @type {string}
2661
- */
2662
- VersionName: string
2663
- /**
2664
- * @api
2665
- * @type {string}
2666
- */
2667
- CreatorDisplayName: string
2668
- /**
2669
- * @api
2670
- * @type {string}
2671
- */
2672
- Comment: string
2673
- /**
2674
- * Update file to current version.
2675
- * @examplecode ITHit.WebDAV.Client.Tests.Versions.ManageVersions.UpdateToThis
2676
- * @examplecode ITHit.WebDAV.Client.TSExamples.Versions.ManageVersions.UpdateToThis
2677
- * @api
2678
- * @param {ITHit.WebDAV.Client.Version~UpdateToThisVersionAsync} fCallback Function to call when operation is completed.
2679
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2680
- */
2681
- UpdateToThisAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2682
- /**
2683
- * Read file content. To download only a part of a file you can specify 2 parameters in ReadContent call.
2684
- * First parameter is the starting byte (zero-based) at witch to start content download, the second – amount
2685
- * of bytes to be downloaded. The library will add Range header to the request in this case.
2686
- * @examplecode ITHit.WebDAV.Client.Tests.Versions.ReadContent.ReadContent
2687
- * @examplecode ITHit.WebDAV.Client.TSExamples.Versions.ReadContent.ReadContent
2688
- * @api
2689
- * @param {number} iBytesFrom Start position to retrieve lBytesCount number of bytes from.
2690
- * @param {number} iBytesCount Number of bytes to retrieve.
2691
- * @param {ITHit.WebDAV.Client.File~ReadContentAsyncCallback} fCallback Function to call when operation is completed.
2692
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2693
- */
2694
- ReadContentAsync(iBytesFrom: number, iBytesCount: number, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2695
- /**
2696
- * Writes file content.
2697
- * @api
2698
- * @param {string} sContent File content.
2699
- * @param {string} sLockToken Lock token.
2700
- * @param {string} sMimeType File mime-type.
2701
- * @param {ITHit.WebDAV.Client.File~WriteContentAsyncCallback} fCallback Function to call when operation is completed.
2702
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2703
- */
2704
- WriteContentAsync(sContent: string, sLockToken: string, sMimeType: string, fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2705
- /**
2706
- * Refreshes item loading data from server.
2707
- * @api
2708
- * @param {ITHit.WebDAV.Client.HierarchyItem~RefreshAsyncCallback} fCallback Function to call when operation is completed.
2709
- * @returns {ITHit.WebDAV.Client.Request} Request object.
2710
- */
2711
- RefreshAsync(fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
2712
- /**
2713
- * Length of the file.
2714
- * @api
2715
- * @type {number}
2716
- */
2717
- ContentLength: number
2718
- /**
2719
- * Content type of the file.
2720
- * @api
2721
- * @type {string}
2722
- */
2723
- ContentType: string
2724
- /**
2725
- * Current WebDAV session.
2726
- * @api
2727
- * @type {ITHit.WebDAV.Client.WebDavSession}
2728
- */
2729
- Session: ITHit.WebDAV.Client.WebDavSession
2730
- /**
2731
- * This item path on the server.
2732
- * @api
2733
- * @type {string}
2734
- */
2735
- Href: string
2736
- /**
2737
- * User friendly item name.
2738
- * @api
2739
- * @type {string}
2740
- */
2741
- DisplayName: string
2742
- /**
2743
- * The date item was created.
2744
- * @api
2745
- * @type {Date}
2746
- */
2747
- CreationDate: Date
2748
- /**
2749
- * List of item properties.
2750
- * @api
2751
- * @type {ITHit.WebDAV.Client.PropertyList}
2752
- */
2753
- Properties: ITHit.WebDAV.Client.PropertyList
2754
- }/**
2755
- * Represents information about errors occurred in different elements.
2756
- * @api
2757
- * @class ITHit.WebDAV.Client.Error
2758
- */
2759
- class Error {
2760
- /**
2761
- * Gets the generic description, if available.
2762
- * @api
2763
- * @type {string}
2764
- */
2765
- Description: string
2766
- /**
2767
- * Array of the errors returned by server.
2768
- * @api
2769
- * @type {ITHit.WebDAV.Client.MultistatusResponse[]}
2770
- */
2771
- Responses: ITHit.WebDAV.Client.MultistatusResponse[]
2772
- }/**
2773
- * This class represents asynchronous request to WebDAV server. The instance of this class is returned from most
2774
- * asynchronous methods of the library. You can use it to cancel the request calling Abort() method of this class
2775
- * as well as to show progress attaching to Progress event.
2776
- * @api
2777
- * @class ITHit.WebDAV.Client.WebDavRequest
2778
- */
2779
- class WebDavRequest {
2780
- }/**
2781
- * Represents a context for one or many requests.
2782
- * @api
2783
- * @class ITHit.WebDAV.Client.RequestProgress
2784
- */
2785
- class RequestProgress {
2786
- /**
2787
- * Progress in percents
2788
- * @api
2789
- * @type {number}
2790
- */
2791
- Percent: number
2792
- /**
2793
- * Count of complete operations
2794
- * @api
2795
- * @type {number}
2796
- */
2797
- CountComplete: number
2798
- /**
2799
- * Total operations count
2800
- * @api
2801
- * @type {number}
2802
- */
2803
- CountTotal: number
2804
- /**
2805
- * Count of loaded bytes
2806
- * @api
2807
- * @type {number}
2808
- */
2809
- BytesLoaded: number
2810
- /**
2811
- * Total bytes. This param can be changed in progress, if request has many operations (sub-requests).
2812
- * @api
2813
- * @type {number}
2814
- */
2815
- BytesTotal: number
2816
- /**
2817
- * Flag indicating if the resource concerned by the XMLHttpRequest ProgressEvent has a length that can be calculated.
2818
- * @api
2819
- * @type {boolean}
2820
- */
2821
- LengthComputable: boolean
2822
- }/**
2823
- * Represents a context for one or many requests.
2824
- * @api
2825
- * @fires ITHit.WebDAV.Client.Request#OnProgress
2826
- * @fires ITHit.WebDAV.Client.Request#OnError
2827
- * @fires ITHit.WebDAV.Client.Request#OnFinish
2828
- * @class ITHit.WebDAV.Client.Request
2829
- */
2830
- class Request {
2831
- /**
2832
- * Progress event trigger on update information about request progress.
2833
- * See {@link ITHit.WebDAV.Client.RequestProgress} for more information.
2834
- * @api
2835
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.Progress.Progress
2836
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.Progress.Progress
2837
- * @event ITHit.WebDAV.Client.Request#OnProgress
2838
- * @property {ITHit.WebDAV.Client.RequestProgress} Progress Progress info instance
2839
- * @property {ITHit.WebDAV.Client.Request} Request Current request
2840
- */
2841
- /**
2842
- * Error event trigger when one of request operations have error.
2843
- * Notice: This event trigger before async method callback.
2844
- * @api
2845
- * @event ITHit.WebDAV.Client.Request#OnError
2846
- * @property {Error|ITHit.WebDAV.Client.Exceptions.WebDavException} Error Error object
2847
- * @property {ITHit.WebDAV.Client.Request} Request Current request
2848
- */
2849
- /**
2850
- * Finish event trigger once when all operations in requests is complete.
2851
- * Notice: This event trigger before async method callback.
2852
- * @api
2853
- * @event ITHit.WebDAV.Client.Request#OnFinish
2854
- * @property {ITHit.WebDAV.Client.Request} Request Current request
2855
- */
2856
- /**
2857
- * Progress info object, auto updated on `OnProgress` event.
2858
- * @api
2859
- * @type {ITHit.WebDAV.Client.RequestProgress}
2860
- */
2861
- Progress: ITHit.WebDAV.Client.RequestProgress
2862
- /**
2863
- * Progress info object, auto updated on `OnUploadProgress` event.
2864
- * @public
2865
- * @type {ITHit.WebDAV.Client.RequestProgress}
2866
- */
2867
- UploadProgress: ITHit.WebDAV.Client.RequestProgress
2868
- /**
2869
- * @api
2870
- * @param {string} sEventName
2871
- * @param {function} fCallback
2872
- * @param {object} [oContext]
2873
- */
2874
- AddListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
2875
- /**
2876
- * @api
2877
- * @param {string} sEventName
2878
- * @param {function} fCallback
2879
- * @param {object} [oContext]
2880
- */
2881
- RemoveListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
2882
- /**
2883
- * Cancels asynchronous request. The Finish event and the callback function will be called immediately after this method call.
2884
- * @api
2885
- */
2886
- Abort(): void;
2887
- /**
2888
- * Cancels asynchronous request. The Finish event and the callback function will not be called after this method call.
2889
- * @public
2890
- */
2891
- AbortAsync(): void;
2892
- }/**
2893
- * @classdesc Session for accessing WebDAV servers.
2894
- * @example
2895
- * &lt;!DOCTYPE html&gt;
2896
- * &lt;html lang="en"&gt;
2897
- * &lt;head&gt;
2898
- * &lt;title&gt;IT Hit WebDAV Ajax Library&lt;/title&gt;
2899
- * &lt;script src="http://www.ajaxbrowser.com/ITHitService/WebDAVAJAXLibrary/ITHitWebDAVClient.js" type="text/javascript"&gt;&lt;/script&gt;
2900
- * &lt;script type="text/javascript"&gt;
2901
- * var sFolderUrl = 'http://localhost:35829/';
2902
- * var oSession = new ITHit.WebDAV.Client.WebDavSession();
2903
- *
2904
- * oSession.OpenFolderAsync(sFolderUrl, null, function (oFolderAsyncResult) {
2905
- * if (!oFolderAsyncResult.IsSuccess) {
2906
- * console.error(oFolderAsyncResult.Error);
2907
- * return;
2908
- * }
2909
- *
2910
- * /&#42;&#42; &#64;typedef {ITHit.WebDAV.Client.Folder} oFolder &#42;/
2911
- * var oFolder = oFolderAsyncResult.Result;
2912
- *
2913
- * console.log(oFolder.Href);
2914
- *
2915
- * oFolder.GetChildrenAsync(false, null, function (oAsyncResult) {
2916
- * if (!oAsyncResult.IsSuccess) {
2917
- * console.error(oFolderAsyncResult.Error);
2918
- * return;
2919
- * }
2920
- *
2921
- * /&#42;&#42; &#64;typedef {ITHit.WebDAV.Client.HierarchyItem[]} aHierarchyItems &#42;/
2922
- * var aHierarchyItems = oAsyncResult.Result;
2923
- *
2924
- * for (var i = 0, l = aHierarchyItems.length; i &lt; l; i++) {
2925
- * var sSize = aHierarchyItems[i].ResourceType !== ITHit.WebDAV.Client.ResourceType.Folder ?
2926
- * Math.round(aHierarchyItems[i].ContentLength / 1000) + ' Kb' :
2927
- * null;
2928
- * console.log(' [' + aHierarchyItems[i].ResourceType + '] ' + aHierarchyItems[i].DisplayName + (sSize ? ', ' + sSize : ''));
2929
- * }
2930
- * });
2931
- * });
2932
- * &lt;/script&gt;
2933
- * &lt;/head&gt;
2934
- * &lt;body&gt;
2935
- * &lt;/body&gt;
2936
- * &lt;/html&gt;
2937
- * @api
2938
- * @fires ITHit.WebDAV.Client.WebDavSession#OnBeforeRequestSend
2939
- * @fires ITHit.WebDAV.Client.WebDavSession#OnResponse
2940
- * @constructs
2941
- */
2942
- namespace WebDavSession{
2943
- /**
2944
- * Protocol Version of AJAX Library
2945
- * @api
2946
- */
2947
- function ProtocolVersion(): void;
2948
- }class WebDavSession {
2949
- /**
2950
- * Version of AJAX Library
2951
- * @api
2952
- * @type {string}
2953
- */
2954
- static Version: string
2955
- Version: string
2956
- /**
2957
- * The OnBeforeRequestSend event is fired before request is being submitted to server and provides all
2958
- * information that is used when creating the request such as URL, HTTP verb, headers and request body.
2959
- * @api
2960
- * @examplecode ITHit.WebDAV.Client.Tests.WebDavSession.Events.BeforeRequestSend
2961
- * @examplecode ITHit.WebDAV.Client.TSExamples.WebDavSession.Events.BeforeRequestSend
2962
- * @event ITHit.WebDAV.Client.WebDavSession#OnBeforeRequestSend
2963
- * @property {string} Method Request method
2964
- * @property {string} Href Request absolute path
2965
- * @property {object} Headers Key-value object with headers
2966
- * @property {string} Body Request Body
2967
- */
2968
- /**
2969
- * The OnResponse event fires when the data is received from server. In your event handler you can update
2970
- * any data received from server.
2971
- * @api
2972
- * @examplecode ITHit.WebDAV.Client.Tests.WebDavSession.Events.Response
2973
- * @examplecode ITHit.WebDAV.Client.TSExamples.WebDavSession.Events.Response
2974
- * @event ITHit.WebDAV.Client.WebDavSession#OnResponse
2975
- * @property {number} Status Response status code
2976
- * @property {string} StatusDescription Response status description
2977
- * @property {object} Headers Key-value object with headers
2978
- * @property {string} Body Response Body
2979
- */
2980
- /**
2981
- * @api
2982
- * @param {string} sEventName
2983
- * @param {function} fCallback
2984
- * @param {object} [oContext]
2985
- */
2986
- AddListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
2987
- /**
2988
- * @api
2989
- * @param {string} sEventName
2990
- * @param {function} fCallback
2991
- * @param {object} [oContext]
2992
- */
2993
- RemoveListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
2994
- /**
2995
- * Load File object corresponding to path.
2996
- * @api
2997
- * @param {string} sPath Path to the file.
2998
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
2999
- * @param {ITHit.WebDAV.Client.WebDavSession~OpenFileAsyncCallback} fCallback Function to call when operation is completed.
3000
- * @returns {ITHit.WebDAV.Client.Request} Request object.
3001
- */
3002
- OpenFileAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
3003
- /**
3004
- * Returns Folder object corresponding to path.
3005
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.GetItemBySession.GetFolder
3006
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.GetItemBySession.GetFolder
3007
- * @api
3008
- * @param {string} sPath Path to the folder.
3009
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
3010
- * @param {ITHit.WebDAV.Client.WebDavSession~OpenFolderAsyncCallback} fCallback Function to call when operation is completed.
3011
- */
3012
- OpenFolderAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
3013
- /**
3014
- * Returns HierarchyItem object corresponding to path.
3015
- * @api
3016
- * @param {string} sPath Path to the resource.
3017
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
3018
- * @param {ITHit.WebDAV.Client.WebDavSession~OpenItemAsyncCallback} fCallback Function to call when operation is completed.
3019
- */
3020
- OpenItemAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
3021
- /**
3022
- * Creates folder corresponding to path.
3023
- * @api
3024
- * @param {string} sPath Path to the resource.
3025
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
3026
- * @param {ITHit.WebDAV.Client.WebDavSession~CreateFolderAsyncCallback} fCallback Function to call when operation is completed.
3027
- */
3028
- CreateFolderAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
3029
- }
3030
- namespace Upload{
3031
- /**
3032
- * Upload state.
3033
- * @api
3034
- * @enum {string}
3035
- * @readonly
3036
- * @class ITHit.WebDAV.Client.Upload.State
3037
- */
3038
- enum State{
3039
- Uploading = "Uploading",
3040
- Canceled = "Canceled",
3041
- Paused = "Paused",
3042
- Queued = "Queued",
3043
- Failed = "Failed",
3044
- Completed = "Completed",
3045
- Retrying = "Retrying",
3046
- Skipped = "Skipped",
3047
- }/**
3048
- * This class represents progress state of upload.
3049
- * @api
3050
- * @class ITHit.WebDAV.Client.Upload.Progress
3051
- */
3052
- class Progress {
3053
- /**
3054
- * Bytes uploaded.
3055
- * @api
3056
- * @type {!number}
3057
- */
3058
- UploadedBytes: number
3059
- /**
3060
- * Total bytes to upload.
3061
- * @api
3062
- * @type {!number}
3063
- */
3064
- TotalBytes: number
3065
- /**
3066
- * Elapsed time in seconds.
3067
- * @api
3068
- * @type {!number}
3069
- */
3070
- ElapsedTime: number
3071
- /**
3072
- * Time left in seconds.
3073
- * @api
3074
- * @type {!number}
3075
- */
3076
- RemainingTime: number
3077
- /**
3078
- * Progress in percents.
3079
- * @api
3080
- * @type {!number}
3081
- */
3082
- Completed: number
3083
- /**
3084
- * Speed in bytes/s.
3085
- * @api
3086
- * @type {!number}
3087
- */
3088
- Speed: number
3089
- }/**
3090
- * This class represents file or folder in unify form.
3091
- * @public
3092
- * @alias ITHit.WebDAV.Client.Upload.FSEntry
3093
- * @constructs
3094
- *
3095
- * @param {string} sPath The path without resource name.
3096
- * @param {File} [oFile] The file object.
3097
- */
3098
- namespace FSEntry{
3099
- /**
3100
- * @public
3101
- * @readonly
3102
- */
3103
- function PathSeparator(): void;
3104
- /**
3105
- * Creates entry.
3106
- * @public
3107
- * @param {string[]} aPathParts
3108
- * @param {File} [oFile]
3109
- * @return {ITHit.WebDAV.Client.Upload.FSEntry}
3110
- */
3111
- function CreateFromPathParts(aPathParts: string[], oFile?: File | null): ITHit.WebDAV.Client.Upload.FSEntry;
3112
- }class FSEntry {
3113
- constructor(sPath: string, oFile?: File | null);
3114
- /**
3115
- * Returns relative path of entry on file system.
3116
- * @public
3117
- * @return {string}
3118
- */
3119
- GetRelativePath(): string;
3120
- }/**
3121
- * Represents a file or folder being uploaded. Provides functions to discover item state, get info about upload
3122
- * progress as well as to pause, resume and cancel upload.
3123
- * @api
3124
- * @class ITHit.WebDAV.Client.Upload.UploadItem
3125
- * @param {string} sUrl
3126
- * @param {ITHit.WebDAV.Client.Upload.FSEntry} oFsEntry
3127
- * @param {ITHit.WebDAV.Client.Upload.Controls.HtmlControl} oBinding
3128
- * @param {ITHit.WebDAV.Client.Upload.UploaderSession} oSession
3129
- * @param {ITHit.WebDAV.Client.Upload.Groups.GroupManager} oGroupManager
3130
- * @param {ITHit.WebDAV.Client.Upload.Settings} oSettings
3131
- */
3132
- class UploadItem {
3133
- 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);
3134
- /**
3135
- * Event reporting that upload item state changed.
3136
- * @api
3137
- * @event ITHit.WebDAV.Client.Upload.UploadItem#OnStateChanged
3138
- * @property {ITHit.WebDAV.Client.Upload.UploadItem} Sender Upload item instance.
3139
- * @property {string} Name Event name.
3140
- * @property {ITHit.WebDAV.Client.Upload.State} OldState Previous state.
3141
- * @property {ITHit.WebDAV.Client.Upload.State} NewState Actual state.
3142
- * @example
3143
- * /&#x002A&#x002A @typedef {ITHit.WebDAV.Client.Upload.UploadItem} oItem &#x002A/
3144
- * var oItem = oUploader.Queue.GetByUrl(sSomeUrl);
3145
- * oItem.AddListener('OnStateChanged', function (oStateChanged) {
3146
- * console.log('Upload to:' + oStateChanged.Sender.GetUrl() + ', changed state to :' + oStateChanged.NewState);
3147
- * });
3148
- *
3149
- */
3150
- /**
3151
- * Event reporting that upload item progress changed.
3152
- * @api
3153
- * @event ITHit.WebDAV.Client.Upload.UploadItem#OnProgressChanged
3154
- * @property {ITHit.WebDAV.Client.Upload.UploadItem} Sender Upload item instance.
3155
- * @property {string} Name Event name.
3156
- * @property {ITHit.WebDAV.Client.Upload.Progress} OldProgress Previous progress.
3157
- * @property {ITHit.WebDAV.Client.Upload.Progress} NewProgress Actual progress.
3158
- * @example
3159
- * /&#x002A&#x002A @typedef {ITHit.WebDAV.Client.Upload.UploadItem} oItem &#x002A/
3160
- * var oItem = oUploader.Queue.GetByUrl(sSomeUrl);
3161
- * oItem.AddListener('OnProgressChanged', function (oProgressChanged) {
3162
- * console.log('Upload to:' + oStateChanged.Sender.GetUrl() + ', completed by:' + oProgressChanged.NewProgress.Completed + '%');
3163
- * });
3164
- *
3165
- */
3166
- /**
3167
- * Event reporting that upload error occurred.
3168
- * @api
3169
- * @event ITHit.WebDAV.Client.Upload.UploadItem#OnError
3170
- * @property {ITHit.WebDAV.Client.Upload.UploadItem} Sender Upload item instance.
3171
- * @property {string} Name Event name.
3172
- * @property {Error|ITHit.WebDAV.Client.Exceptions.WebDavException} Error.
3173
- * @example
3174
- * /&#x002A&#x002A @typedef {ITHit.WebDAV.Client.Upload.UploadItem} oItem &#x002A/
3175
- * var oItem = oUploader.Queue.GetByUrl(sSomeUrl);
3176
- * oItem.AddListener('OnError', function (oOnError) {
3177
- * console.log('Upload to:' + oOnError.Sender.GetUrl() + ', failed with error:' + oOnError.Error.toString());
3178
- * });
3179
- *
3180
- */
3181
- /**
3182
- * Event fired before {@link ITHit.WebDAV.Client.Upload.UploadItem} started upload.
3183
- * You will validate item in this event and present user interface if user interaction is necessary.
3184
- * In this event you can check if each item exists on the server and specify if item should be overwritten or skipped.
3185
- * You can also validate file size, file extension, file upload path and file name.
3186
- *
3187
- * To continue upload the {@link ITHit.WebDAV.Client.Upload.Events.BeforeUploadStarted#Upload} function should be called.
3188
- * To skip upload the {@link ITHit.WebDAV.Client.Upload.Events.BeforeUploadStarted#Skip} function should be called.
3189
- * @api
3190
- * @event ITHit.WebDAV.Client.Upload.UploadItem#OnBeforeUploadStarted
3191
- * @type {ITHit.WebDAV.Client.Upload.Events.BeforeUploadStarted}
3192
- * @example
3193
- * /&#x002A&#x002A @typedef {ITHit.WebDAV.Client.Upload.UploadItem} oItem &#x002A/
3194
- * var oItem = oUploader.Queue.GetByUrl(sSomeUrl);
3195
- * oItem.AddListener('OnBeforeUploadStarted', function(oBeforeUploadStarted) {
3196
- * WebDAVController.WebDavSession.OpenItemAsync(sHref,
3197
- * [],
3198
- * function(oAsyncResult) {
3199
- * if (oAsyncResult.IsSuccess) {
3200
- * oItem.SetSkip(true);
3201
- * }
3202
- *
3203
- * oBeforeUploadStarted.Done();
3204
- * });
3205
- * });
3206
- */
3207
- /**
3208
- * Event fired when is possible to retry failed upload and waited until one of action called.
3209
- * @api
3210
- * @event ITHit.WebDAV.Client.Upload.UploadItem#OnUploadError
3211
- * @type {ITHit.WebDAV.Client.Upload.Events.UploadError}
3212
- * @example
3213
- * /&#x002A&#x002A @typedef {ITHit.WebDAV.Client.Upload.UploadItem} oItem &#x002A/
3214
- * var oItem = oUploader.Queue.GetByUrl(sSomeUrl);
3215
- * AddListener('OnUploadError', function(oUploadError) {
3216
- * setTimeout(function() {
3217
- * oUploadError.Retry();
3218
- * }, 2000)
3219
- * });
3220
- */
3221
- /**
3222
- * Callback function to be called when action performed.
3223
- * @api
3224
- * @callback ITHit.WebDAV.Client.Upload.UploadItem~AsyncCallback
3225
- */
3226
- /**
3227
- * Gets [File]{@link https://www.w3.org/TR/FileAPI/} object. Returns null in case of a folder.
3228
- * @api
3229
- * @return {(globalThis.File | null )}
3230
- */
3231
- GetFile(): globalThis.File | null;
3232
- /**
3233
- * Get target url.
3234
- * @api
3235
- * @return {string} File or folder target upload URL.
3236
- */
3237
- GetUrl(): string;
3238
- /**
3239
- * Gets file or folder name with extension.
3240
- * @api
3241
- * @return {string} File or folder name.
3242
- */
3243
- GetName(): string;
3244
- /**
3245
- * Gets relative path.
3246
- * @api
3247
- * @return {string} File or folder relative path.
3248
- */
3249
- GetRelativePath(): string;
3250
- /**
3251
- * Check if upload item represents a folder item.
3252
- * @api
3253
- * @return {boolean} True if item is a folder. Otherwise - false.
3254
- */
3255
- IsFolder(): boolean;
3256
- /**
3257
- * Gets current upload state.
3258
- * @api
3259
- * @return {(ITHit.WebDAV.Client.Upload.State | string)}
3260
- */
3261
- GetState(): ITHit.WebDAV.Client.Upload.State | string;
3262
- /**
3263
- * Gets object that describes upload progress.
3264
- * @api
3265
- * @return {ITHit.WebDAV.Client.Upload.Progress }
3266
- */
3267
- GetProgress(): ITHit.WebDAV.Client.Upload.Progress;
3268
- /**
3269
- * Gets all upload errors.
3270
- * @api
3271
- * @return {(Error[]|ITHit.WebDAV.Client.Exceptions.WebDavException[])}
3272
- */
3273
- GetErrors(): Error[] | ITHit.WebDAV.Client.Exceptions.WebDavException[];
3274
- /**
3275
- * Gets last upload error.
3276
- * @api
3277
- * @return {(Error|ITHit.WebDAV.Client.Exceptions.WebDavException)}
3278
- */
3279
- GetLastError(): Error | ITHit.WebDAV.Client.Exceptions.WebDavException;
3280
- /**
3281
- * Stores custom data.
3282
- * @api
3283
- * @type {Object}
3284
- */
3285
- CustomData: Object
3286
- /**
3287
- * Sets if the item is overwritten if it exists on the server.
3288
- * 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.
3289
- * @api
3290
- * @param {boolean} Pass true to force the file to be overwritten. Pass false to make upload fail if file exists.
3291
- */
3292
- SetOverwrite(Pass: boolean): void;
3293
- /**
3294
- * Adds HTTP header to upload. Note that depending on your web server and web browser,
3295
- * maximum allowed request header size or size of all headers in total may be limited.
3296
- * @api
3297
- * @param {String} sName Header name.
3298
- * @param {String} sValue Header value.
3299
- */
3300
- AddHeader(sName: String, sValue: String): void;
3301
- /**
3302
- * Gets if the item will be overwritten if it exists on the server.
3303
- * @api
3304
- * @return {boolean} True if the file on the server will be overwritten. Otherwise - false. Default is false.
3305
- */
3306
- GetOverwrite(): boolean;
3307
- /**
3308
- * Sets if the file should be deleted if upload is canceled.
3309
- * By default, the file is deleted if the upload is canceled. To override this behavior, call this method passing false as a parameter.
3310
- * This function must be called on files only.
3311
- * @api
3312
- * @param {boolean} bDelete Specifies if the file should be deleted on cancel. Typically you will pass false if the file existed before upload.
3313
- * You will pass true to set the default behavior and delete the file when the upload is canceled.
3314
- * @throws {ITHit.Exceptions.ArgumentException} Thrown if this function is called on folder item.
3315
- */
3316
- SetDeleteOnCancel(bDelete: boolean): void;
3317
- /**
3318
- * Gets if the file is deleted when the upload is canceled.
3319
- * @api
3320
- * @return {boolean} True if file is deleted when upload is canceled. Otherwise - false. Default is true.
3321
- */
3322
- GetDeleteOnCancel(): boolean;
3323
- /**
3324
- * Sets failed state.
3325
- * Populates item's error with provided error instance.
3326
- * @api
3327
- * @param {ITHit.WebDAV.Client.Exceptions.WebDavException} oError - The error instance that will be set as a failure description.
3328
- * @throws {ITHit.Exceptions.ArgumentException} - Thrown if argument is not derived from {@link ITHit.WebDAV.Client.Exceptions.WebDavException}.
3329
- * @example
3330
- * var oUploader = new ITHit.WebDAV.Client.Upload.Uploader();
3331
- * oUploader.Queue.OnUploadItemsCreated = function(oUploadItemsCreated) {
3332
- * var sErrorMessage = 'Added to queue in failed state';
3333
- * var oWebDavException = new ITHit.WebDAV.Client.Exceptions.WebDavException(sMessage);
3334
- *
3335
- * /&#42;&#42; &#64;typedef {ITHit.WebDAV.Client.Upload.UploadItem[]} aItemsToUpload &#42;/
3336
- * oUploadItemsCreated.Items.forEach(function(oItem) {
3337
- * oItem.SetFailed(oWebDavException);
3338
- * }
3339
- *
3340
- * oUploadItemsCreated.Upload(oUploadItemsCreated.Items);
3341
- * });
3342
- *
3343
- */
3344
- SetFailed(oError: ITHit.WebDAV.Client.Exceptions.WebDavException): void;
3345
- /**
3346
- * Begins upload.
3347
- * @api
3348
- * @param {ITHit.WebDAV.Client.Upload.UploadItem~AsyncCallback} [fCallback] The callback to call when upload is paused.
3349
- */
3350
- StartAsync(fCallback?: () => void | null): void;
3351
- /**
3352
- * Pauses upload.
3353
- * @api
3354
- * @param {ITHit.WebDAV.Client.Upload.UploadItem~AsyncCallback} [fCallback] The callback to call when upload is paused.
3355
- */
3356
- PauseAsync(fCallback?: () => void | null): void;
3357
- /**
3358
- * Aborts upload.
3359
- * @api
3360
- * @param {number} [iTryCount] Number of times to try to delete the file if the file did not exist on the server before upload.
3361
- * Pass 0 to not try to delete the file. Default is: 5.
3362
- * @param {number} [iDelayAttempt] Delay between attempts to delete in milliseconds. Default is: 500.
3363
- * @param {ITHit.WebDAV.Client.Upload.UploadItem~AsyncCallback} [fCallback] The callback to call when upload is cancelled.
3364
- */
3365
- CancelAsync(iTryCount?: number | null, iDelayAttempt?: number | null, fCallback?: () => void | null): void;
3366
- /**
3367
- * Add event handlers.
3368
- * @api
3369
- * @param {string} sEventName The event name to handle.
3370
- * @param {Function} fCallback The callback to call.
3371
- * @param {object} [oContext] The context to callback is called with.
3372
- */
3373
- AddListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
3374
- /**
3375
- * Remove event listener.
3376
- * @api
3377
- * @param {string} sEventName The event name to remove.
3378
- * @param {Function} fCallback The callback to call.
3379
- * @param {object} [oContext] The context to callback is called with.
3380
- */
3381
- RemoveListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
3382
- /**
3383
- * @public
3384
- * @return {ITHit.WebDAV.Client.Upload.Groups.GroupManager}
3385
- */
3386
- GetGroup(): ITHit.WebDAV.Client.Upload.Groups.GroupManager;
3387
- }/**
3388
- * @alias ITHit.WebDAV.Client.Upload.FileSpan
3389
- * @constructs
3390
- * @public
3391
- * @param {Blob} oFile
3392
- * @param {number} [iStart]
3393
- * @param {(number | null)} [iEnd]
3394
- */
3395
- class FileSpan {
3396
- constructor(oFile: Blob, iStart?: number | null, iEnd?: number | null);
3397
- /**
3398
- * Gets start of the span.
3399
- * @public
3400
- * @return {number}
3401
- */
3402
- GetStart(): number;
3403
- /**
3404
- * Sets start of the span.
3405
- * @public
3406
- * @param {number} iStart
3407
- */
3408
- SetStart(iStart: number): void;
3409
- /**
3410
- * Gets end of the span. Match end of file if null.
3411
- * @public
3412
- * @return {number}
3413
- */
3414
- GetEnd(): number;
3415
- /**
3416
- * Sets end of the span. Match end of file if null.
3417
- * @public
3418
- * @param {(number | null)} iEnd
3419
- */
3420
- SetEnd(iEnd: number | null): void;
3421
- }/**
3422
- * @public
3423
- * @class ITHit.WebDAV.Client.Upload.UploaderSession
3424
- * @extends ITHit.WebDAV.Client.WebDavSession
3425
- */
3426
- class UploaderSession extends ITHit.WebDAV.Client.WebDavSession {
3427
- /**
3428
- * Returns progress report corresponding to path.
3429
- * @public
3430
- * @param {string} sUrl The url to resource.
3431
- * @param {ITHit.WebDAV.Client.UploaderSession~GetProgressReportAsyncCallback} fCallback
3432
- * @param {Object} [thisArg]
3433
- * @return {* | ITHit.WebDAV.Client.Request} Request object.
3434
- */
3435
- GetProgressReportAsync(sUrl: string, fCallback: (oResult: ITHit.WebDAV.Client.AsyncResult) => void, thisArg?: Object | null): any | ITHit.WebDAV.Client.Request;
3436
- /**
3437
- * Returns progress report corresponding to path.
3438
- * @public
3439
- * @param {string} sUrl The url to resource.
3440
- * @return {* | ITHit.WebDAV.Client.Request} Request object.
3441
- */
3442
- GetProgressReport(sUrl: string): any | ITHit.WebDAV.Client.Request;
3443
- /**
3444
- * The OnBeforeRequestSend event is fired before request is being submitted to server and provides all
3445
- * information that is used when creating the request such as URL, HTTP verb, headers and request body.
3446
- * @api
3447
- * @examplecode ITHit.WebDAV.Client.Tests.WebDavSession.Events.BeforeRequestSend
3448
- * @examplecode ITHit.WebDAV.Client.TSExamples.WebDavSession.Events.BeforeRequestSend
3449
- * @event ITHit.WebDAV.Client.WebDavSession#OnBeforeRequestSend
3450
- * @property {string} Method Request method
3451
- * @property {string} Href Request absolute path
3452
- * @property {object} Headers Key-value object with headers
3453
- * @property {string} Body Request Body
3454
- */
3455
- /**
3456
- * The OnResponse event fires when the data is received from server. In your event handler you can update
3457
- * any data received from server.
3458
- * @api
3459
- * @examplecode ITHit.WebDAV.Client.Tests.WebDavSession.Events.Response
3460
- * @examplecode ITHit.WebDAV.Client.TSExamples.WebDavSession.Events.Response
3461
- * @event ITHit.WebDAV.Client.WebDavSession#OnResponse
3462
- * @property {number} Status Response status code
3463
- * @property {string} StatusDescription Response status description
3464
- * @property {object} Headers Key-value object with headers
3465
- * @property {string} Body Response Body
3466
- */
3467
- /**
3468
- * @api
3469
- * @param {string} sEventName
3470
- * @param {function} fCallback
3471
- * @param {object} [oContext]
3472
- */
3473
- AddListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
3474
- /**
3475
- * @api
3476
- * @param {string} sEventName
3477
- * @param {function} fCallback
3478
- * @param {object} [oContext]
3479
- */
3480
- RemoveListener(sEventName: string, fCallback: Function, oContext?: object | null): void;
3481
- /**
3482
- * Load File object corresponding to path.
3483
- * @api
3484
- * @param {string} sPath Path to the file.
3485
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
3486
- * @param {ITHit.WebDAV.Client.WebDavSession~OpenFileAsyncCallback} fCallback Function to call when operation is completed.
3487
- * @returns {ITHit.WebDAV.Client.Request} Request object.
3488
- */
3489
- OpenFileAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): ITHit.WebDAV.Client.Request;
3490
- /**
3491
- * Returns Folder object corresponding to path.
3492
- * @examplecode ITHit.WebDAV.Client.Tests.HierarchyItems.GetItemBySession.GetFolder
3493
- * @examplecode ITHit.WebDAV.Client.TSExamples.HierarchyItems.GetItemBySession.GetFolder
3494
- * @api
3495
- * @param {string} sPath Path to the folder.
3496
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
3497
- * @param {ITHit.WebDAV.Client.WebDavSession~OpenFolderAsyncCallback} fCallback Function to call when operation is completed.
3498
- */
3499
- OpenFolderAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
3500
- /**
3501
- * Returns HierarchyItem object corresponding to path.
3502
- * @api
3503
- * @param {string} sPath Path to the resource.
3504
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
3505
- * @param {ITHit.WebDAV.Client.WebDavSession~OpenItemAsyncCallback} fCallback Function to call when operation is completed.
3506
- */
3507
- OpenItemAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
3508
- /**
3509
- * Creates folder corresponding to path.
3510
- * @api
3511
- * @param {string} sPath Path to the resource.
3512
- * @param {ITHit.WebDAV.Client.PropertyName[]} aProperties Additional properties requested from server. Default is empty array.
3513
- * @param {ITHit.WebDAV.Client.WebDavSession~CreateFolderAsyncCallback} fCallback Function to call when operation is completed.
3514
- */
3515
- CreateFolderAsync(sPath: string, aProperties: ITHit.WebDAV.Client.PropertyName[], fCallback?: (oResult: ITHit.WebDAV.Client.AsyncResult) => void | null): void;
3516
- }/**
3517
- * This class provides settings for Uploader.
3518
- * @api
3519
- * @class ITHit.WebDAV.Client.Upload.Settings
3520
- */
3521
- class Settings {
3522
- /**
3523
- * Number of active uploads same time.
3524
- * Number of concurrent uploads.
3525
- * @api
3526
- * @type {number}
3527
- * @default 2
3528
- */
3529
- ConcurrentUploads: number
3530
- /**
3531
- * Default queue state.
3532
- * @api
3533
- * @type {(ITHit.WebDAV.Client.Upload.State.Queued|string)}
3534
- * @default ITHit.WebDAV.Client.Upload.State.Queued
3535
- */
3536
- State: ITHit.WebDAV.Client.Upload.State.Queued | string
3537
- /**
3538
- * Default cancel behaviour.
3539
- * @api
3540
- * @type {!boolean}
3541
- * @default true
3542
- */
3543
- DeleteOnCancel: boolean
3544
- }/**
3545
- * List of items being uploaded. Each item in the list describes the file
3546
- * or folder upload state and provides methods for managing upload.
3547
- * @api
3548
- * @class ITHit.WebDAV.Client.Upload.Queue
3549
- * @fires ITHit.WebDAV.Client.Upload.Queue#OnQueueChanged
3550
- */
3551
- class Queue {
3552
- /**
3553
- * Event reporting that queue changed. Fired when item is added or deleted from queue.
3554
- * @api
3555
- * @event ITHit.WebDAV.Client.Upload.Queue#OnQueueChanged
3556
- * @property {ITHit.WebDAV.Client.Upload.Queue} Sender The queue instance.
3557
- * @property {string} Name Event name.
3558
- * @property {ITHit.WebDAV.Client.Upload.UploadItem[]} AddedItems Added items.
3559
- * @property {ITHit.WebDAV.Client.Upload.UploadItem[]} RemovedItems Removed items.
3560
- * @example
3561
- * var oUploader = new ITHit.WebDAV.Client.Upload.Uploader();
3562
- * oUploader.Queue.AddListener('OnQueueChanged', function (oQueueChanged) {
3563
- *
3564
- * oQueueChanged.AddedItems.forEach(function(element) {
3565
- * console.log('Upload added:' + element.GetName());
3566
- * });
3567
- * };
3568
- */
3569
- /**
3570
- * Event fired {@link ITHit.WebDAV.Client.Upload.UploadItem}s are created.
3571
- * You will validate files selected for upload in this event and present user interface if user interaction is necessary.
3572
- * In this event you can check if each item exists on the server and specify if item should be overwritten or skipped.
3573
- * You can also validate file size, file extension, file upload path and file name.
3574
- *
3575
- * To continue upload the {@link ITHit.WebDAV.Client.Upload.Events.UploadItemsCreated#Upload} function with the list of items to be uploaded should be called.
3576
- * @api
3577
- * @event ITHit.WebDAV.Client.Upload.Queue#OnUploadItemsCreated
3578
- * @type {ITHit.WebDAV.Client.Upload.Events.UploadItemsCreated}
3579
- * @example
3580
- * var oUploader = new ITHit.WebDAV.Client.Upload.Uploader();
3581
- * oUploader.Queue.AddListener('OnUploadItemsCreated', function(oUploadItemsCreated) {
3582
- * var aIgnoredNames = ['file1.txt', 'file2.txt'];
3583
- *
3584
- * /&#42;&#42; &#64;typedef {ITHit.WebDAV.Client.Upload.UploadItem[]} aItems &#42;/
3585
- * var aItems = oUploadItemsCreated.Items;
3586
- * /&#42;&#42; &#64;typedef {ITHit.WebDAV.Client.Upload.UploadItem[]} aItemsToUpload &#42;/
3587
- * var aItemsToUpload = aItems.filter(function(oItem) {
3588
- * aIgnoredNames.indexOf(oItem.GetName()) < 0
3589
- * }
3590
- *
3591
- * oUploadItemsCreated.Upload(aItemsToUpload);
3592
- * });
3593
- *
3594
- */
3595
- /**
3596
- * Associated uploader.
3597
- * @api
3598
- * @type {ITHit.WebDAV.Client.Upload.Uploader}
3599
- */
3600
- Uploader: ITHit.WebDAV.Client.Upload.Uploader
3601
- /**
3602
- * Adds uploads to the queue.
3603
- * @public
3604
- * @param {string} sUrl Url to upload.
3605
- * @param {ITHit.WebDAV.Client.Upload.FSEntry[]} aFSEntries Items to Upload.
3606
- * @param {ITHit.WebDAV.Client.Upload.Controls.HtmlControl} [oSource] Source of items.
3607
- */
3608
- AddGroup(sUrl: string, aFSEntries: ITHit.WebDAV.Client.Upload.FSEntry[], oSource?: ITHit.WebDAV.Client.Upload.Controls.HtmlControl | null): void;
3609
- /**
3610
- * @api
3611
- * Restart queued upload of {@link ITHit.WebDAV.Client.Upload.UploadItem}s collection.
3612
- * @param {ITHit.WebDAV.Client.Upload.UploadItem[]} aUploadItems Collection restart.
3613
- */
3614
- Restart(aUploadItems: ITHit.WebDAV.Client.Upload.UploadItem[]): void;
3615
- /**
3616
- * Removes upload file from queue.
3617
- * @param {string} sUrl The url of UploadItem to remove.
3618
- * @api
3619
- */
3620
- RemoveByUrl(sUrl: string): void;
3621
- /**
3622
- * Add event handlers.
3623
- * @api
3624
- * @param {string} sEventName The event name to handle.
3625
- * @param {Function} fCallback The callback to call.
3626
- * @param {Object} [oContext] The context to callback is called with.
3627
- */
3628
- AddListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
3629
- /**
3630
- * Removes event listener.
3631
- * @api
3632
- * @param {string} sEventName The event name to remove.
3633
- * @param {Function} fCallback The callback to remove.
3634
- * @param {Object} [oContext] The context to callback is called with.
3635
- */
3636
- RemoveListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
3637
- }/**
3638
- * Instance of this class store drop zones and provide methods to creating
3639
- * and removing them
3640
- * @api
3641
- * @class ITHit.WebDAV.Client.Upload.DropZoneCollection
3642
- */
3643
- class DropZoneCollection {
3644
- /**
3645
- * @api
3646
- * @type {ITHit.WebDAV.Client.Upload.Uploader}
3647
- */
3648
- Uploader: ITHit.WebDAV.Client.Upload.Uploader
3649
- /**
3650
- * Bind HTML element as drop zone.
3651
- * @api
3652
- * @example
3653
- * &lt;!DOCTYPE html&gt;
3654
- * &lt;html&gt;
3655
- * &lt;head&gt;
3656
- * &lt;script type="text/javascript"&gt;
3657
- * var oUploader = new ITHit.WebDAV.Client.Upload.Uploader();
3658
- * oUploader.DropZones.AddById('ithit-dropzone');
3659
- * &lt;/script&gt;
3660
- * &lt;/head&gt;
3661
- * &lt;body
3662
- * &lt;div id="ithit-dropzone"&gt;
3663
- * Drop file to upload&lt;
3664
- * &lt;/div&gt;
3665
- * &lt;/body&gt;
3666
- * &lt;/html&gt;
3667
- * @param {string} sElementId Id of HTML element.
3668
- * @return {ITHit.WebDAV.Client.Upload.Controls.DropZone} Created drop zone.
3669
- */
3670
- AddById(sElementId: string): ITHit.WebDAV.Client.Upload.Controls.DropZone;
3671
- /**
3672
- * Get drop zone by Id.
3673
- * @api
3674
- * @param {string} sElementId Id of HTML element.
3675
- * @return {(ITHit.WebDAV.Client.Upload.Controls.DropZone | undefined)} Found drop zone or undefined.
3676
- */
3677
- GetById(sElementId: string): ITHit.WebDAV.Client.Upload.Controls.DropZone | undefined;
3678
- /**
3679
- * Remove HTML element from drop zone Controls by id.
3680
- * @api
3681
- * @param {string} sElementId Id of HTML element.
3682
- */
3683
- RemoveById(sElementId: string): void;
3684
- /**
3685
- * Add event handlers.
3686
- * @public
3687
- * @param {string} sEventName The event name to handle.
3688
- * @param {Function} fCallback The callback to call.
3689
- * @param {Object} [oContext] The context to callback is called with.
3690
- */
3691
- AddListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
3692
- /**
3693
- * Removes event listener.
3694
- * @public
3695
- * @param {string} sEventName The event name to remove.
3696
- * @param {Function} fCallback The callback to remove.
3697
- * @param {Object} [oContext] The context to callback is called with.
3698
- */
3699
- RemoveListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
3700
- /**
3701
- * Event reporting that collection changed. Fired when item is added or deleted from collection.
3702
- * @public
3703
- * @event ITHit.WebDAV.Client.Upload.DropZoneCollection#OnCollectionChanged
3704
- * @property {ITHit.WebDAV.Client.Upload.DropZoneCollection} Sender The collection instance.
3705
- * @property {ITHit.WebDAV.Client.Upload.Controls.DropZone[]} AddedItems Added items.
3706
- * @property {ITHit.WebDAV.Client.Upload.Controls.DropZone[]} RemovedItems Removed items.
3707
- */
3708
- }/**
3709
- * List of upload inputs. Contains items of {@link ITHit.WebDAV.Client.Upload.Controls.Input} type.
3710
- * @api
3711
- * @class ITHit.WebDAV.Client.Upload.InputCollection
3712
- */
3713
- class InputCollection {
3714
- /**
3715
- * @api
3716
- * @type {ITHit.WebDAV.Client.Upload.Uploader}
3717
- */
3718
- Uploader: ITHit.WebDAV.Client.Upload.Uploader
3719
- /**
3720
- * Bind HTML element as input.
3721
- * @api
3722
- * @example
3723
- * &lt;!DOCTYPE html&gt;
3724
- * &lt;html&gt;
3725
- * &lt;head&gt;
3726
- * &lt;script type="text/javascript"&gt;
3727
- * var oUploader = new ITHit.WebDAV.Client.Upload.Uploader();
3728
- * oUploader.Inputs.AddById('ithit-input');
3729
- * &lt;/script&gt;
3730
- * &lt;/head&gt;
3731
- * &lt;body
3732
- * &lt;input id="ithit-input" type="file"&gt;
3733
- * &lt;/body&gt;
3734
- * &lt;/html&gt;
3735
- * @param {string} sElementId Id of HTML element.
3736
- * @return {ITHit.WebDAV.Client.Upload.Controls.Input} Created input object.
3737
- */
3738
- AddById(sElementId: string): ITHit.WebDAV.Client.Upload.Controls.Input;
3739
- /**
3740
- * Get input object by Id.
3741
- * @api
3742
- * @param {string} sElementId Id of HTML element.
3743
- * @return {ITHit.WebDAV.Client.Upload.Controls.Input | undefined} Founded input or undefined.
3744
- */
3745
- GetById(sElementId: string): ITHit.WebDAV.Client.Upload.Controls.Input | undefined;
3746
- /**
3747
- * Remove HTML element from input Controls by id.
3748
- * @api
3749
- * @param {string} sElementId Id of HTML element.
3750
- */
3751
- RemoveById(sElementId: string): void;
3752
- /**
3753
- * Add event handlers.
3754
- * @public
3755
- * @param {string} sEventName The event name to handle.
3756
- * @param {Function} fCallback The callback to call.
3757
- * @param {Object} [oContext] The context to callback is called with.
3758
- */
3759
- AddListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
3760
- /**
3761
- * Removes event listener.
3762
- * @public
3763
- * @param {string} sEventName The event name to remove.
3764
- * @param {Function} fCallback The callback to remove.
3765
- * @param {Object} [oContext] The context to callback is called with.
3766
- */
3767
- RemoveListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
3768
- /**
3769
- * Event reporting that collection changed. Fired when item is added or deleted from collection.
3770
- * @public
3771
- * @event ITHit.WebDAV.Client.Upload.InputCollection#OnCollectionChanged
3772
- * @property {ITHit.WebDAV.Client.Upload.InputCollection} Sender The collection instance.
3773
- * @property {ITHit.WebDAV.Client.Upload.Controls.Input[]} AddedItems Added items.
3774
- * @property {ITHit.WebDAV.Client.Upload.Controls.Input[]} RemovedItems Removed items.
3775
- */
3776
- }/**
3777
- * Create uploader instance.
3778
- * @example
3779
- * &lt;!DOCTYPE html&gt;
3780
- * &lt;html lang="en"&gt;
3781
- * &lt;head&gt;
3782
- * &lt;title&gt;IT Hit WebDAV Uploader&lt;/title&gt;
3783
- * &lt;script src="ITHitWebDAVClient.js" type="text/javascript"&gt;&lt;/script&gt;
3784
- * &lt;link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet"&gt;
3785
- * &lt;script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.0/jquery.min.js"&gt;&lt;/script&gt;
3786
- * &lt;script type="text/javascript"&gt;
3787
- * function UploaderGridView(sSelector) {
3788
- * this.Uploader = new ITHit.WebDAV.Client.Upload.Uploader();
3789
- * this.Uploader.DropZones.AddById('ithit-dropzone');
3790
- * this.Uploader = oUploader;
3791
- * this.Uploader.Queue.AddListener('OnQueueChanged', '_CollectionChange', this);
3792
- * this.$table = $(sSelector);
3793
- * this.rows = [];
3794
- * };
3795
- *
3796
- * /&#x002A&#x002A
3797
- * * Observes adding and deleting of UploadItem and creates and removes rows in table.
3798
- * * @param {ITHit.WebDAV.Client.Upload.Queue#OnQueueChanged} oQueueChanged
3799
- * &#x002A/
3800
- * UploaderGridView.prototype._CollectionChange = function(oQueueChanged) {
3801
- * $.each(oQueueChanged.AddedItems, function(index, value) {
3802
- * var row = new UploaderGridRow(value);
3803
- * this.rows.push(row);
3804
- * this.$table.append(row.$el);
3805
- * }.bind(this));
3806
- *
3807
- * $.each(oQueueChanged.RemovedItems, function(index, value) {
3808
- * var aRows = $.grep(this.rows, function(oElem) { return value === oElem.UploadItem; });
3809
- * var iIndex = this.rows.indexOf(aRows[0]);
3810
- * this.rows.splice(iIndex, 1);
3811
- * aRows[0].$el.remove();
3812
- * }.bind(this));
3813
- * };
3814
- *
3815
- * /&#x002A&#x002A
3816
- * * Represents table row and subscribes for upload change.
3817
- * * @param {ITHit.WebDAV.Client.Upload.oUploadItem} oUploadItem
3818
- * &#x002A/
3819
- * function UploaderGridRow(oUploadItem) {
3820
- * this.$el = $('<tr></tr>');
3821
- * this.oUploadItem = oUploadItem;
3822
- * this.oUploadItem.AddListener('OnProgressChanged', '_OnProgress', this);
3823
- * this.oUploadItem.AddListener('OnStateChanged', '_OnStateChange', this);
3824
- * this._Render(oUploadItem);
3825
- * };
3826
- *
3827
- *
3828
- * /&#x002A&#x002A
3829
- * * Creates upload details view.
3830
- * * @param {ITHit.WebDAV.Client.Upload.oUploadItem} oUploadItem
3831
- * &#x002A/
3832
- * UploaderGridRow.prototype._Render = function(oUploadItem) {
3833
- * /&#x002A&#x002A @typedef {ITHit.WebDAV.Client.Upload.Progress} oProgress &#x002A/
3834
- * var oProgress = oUploadItem.GetProgress();
3835
- * var columns = [
3836
- * oUploadItem.GetName(),
3837
- * oUploadItem.GetUrl(),
3838
- * oUploadItem.GetSize(),
3839
- * oProgress.UploadedBytes,
3840
- * oProgress.Completed,
3841
- * oProgress.ElapsedTime,
3842
- * oProgress.RemainingTime,
3843
- * oProgress.Speed,
3844
- * oUploadItem.GetState()
3845
- * ];
3846
- *
3847
- * var $columns = [];
3848
- * columns.forEach(function(item) {
3849
- * var $column = $('&lt;td&gt;&lt;/td&gt;');
3850
- * $column.html(item);
3851
- * $columns.push($column);
3852
- * });
3853
- *
3854
- * var $actions = $('&lt;td&gt;&lt;/td&gt;');
3855
- * this._RenderActions(oUploadItem).forEach(function(item) {
3856
- * $actions.append(item);
3857
- * });
3858
- *
3859
- * $columns.push($actions);
3860
- * this.$el.empty();
3861
- * this.$el.append($columns);
3862
- * };
3863
- *
3864
- * /&#x002A&#x002A
3865
- * * Creates upload actions view.
3866
- * * @param {ITHit.WebDAV.Client.Upload.oUploadItem} oUploadItem
3867
- * &#x002A/
3868
- * UploaderGridRow.prototype._RenderActions = function(oUploadItem) {
3869
- * var actions = [];
3870
- * actions.push($('&lt;a&gt;&lt;/a&gt;').
3871
- * html('&lt;span class="glyphicon glyphicon-play"&gt;&lt;/span&gt;').
3872
- * attr('href', 'javascript:void(0)').
3873
- * on('click', oUploadItem.StartAsync.bind(oUploadItem)));
3874
- *
3875
- * actions.push($('&lt;a&gt;&lt;/a&gt;').
3876
- * html('&lt;span class="glyphicon glyphicon-stop"&gt;&lt;/span&gt;').
3877
- * attr('href', 'javascript:void(0)').
3878
- * on('click',oUploadItem.CancelAsync.bind(oUploadItem)));
3879
- * };
3880
- *
3881
- * /&#x002A&#x002A
3882
- * * Handles UploadItem state change.
3883
- * * @param {ITHit.WebDAV.Client.Upload.UploadItem#OnStateChanged} oStateChangedEvent
3884
- * &#x002A/
3885
- * UploaderGridRow.prototype._OnStateChange = function(oStateChangedEvent) {
3886
- * this._Render(oStateChangedEvent.Sender);
3887
- * };
3888
- *
3889
- * /&#x002A&#x002A
3890
- * * Handles UploadItem progress change.
3891
- * * @param {ITHit.WebDAV.Client.Upload.UploadItem#OnProgressChanged} oProgressEvent
3892
- * &#x002A/
3893
- * UploaderGridRow.prototype._OnProgress = function(oProgressEvent) {
3894
- * this._Render(oProgressEvent.Sender);
3895
- * };
3896
- *
3897
- * var sUploadUrl = 'https://webdavserver/path/';
3898
- * var oUploaderGrid = new UploaderGridView(oUploader, '.ithit-grid-uploads');
3899
- * oUploaderGrid.Uploader.SetUploadUrl(sUploadUrl);
3900
- * &lt;/script&gt;
3901
- * &lt;/head&gt;
3902
- * &lt;body id="it-hit-dropzone"&gt;
3903
- * &lt;table class="table table-responsive ithit-grid-uploads"&gt;
3904
- * &lt;thead&gt;
3905
- * &lt;tr&gt;
3906
- * &lt;th&gt;Display Name&lt;/th&gt;
3907
- * &lt;th&gt;Download Url&lt;/th&gt;
3908
- * &lt;th&gt;Size&lt;/th&gt;
3909
- * &lt;th&gt;Uploaded Bytes&lt;/th&gt;
3910
- * &lt;th&gt;Completed&lt;/th&gt;
3911
- * &lt;th&gt;Elapsed TimeSpan&lt;/th&gt;
3912
- * &lt;th&gt;Remaining TimeSpan&lt;/th&gt;
3913
- * &lt;th&gt;Speed&lt;/th&gt;
3914
- * &lt;th&gt;State&lt;/th&gt;
3915
- * &lt;th&gt;Actions&lt;/th&gt;
3916
- * &lt;/tr&gt;
3917
- * &lt;/thead&gt;
3918
- * &lt;tbody&gt;
3919
- * &lt;/tbody&gt;
3920
- * &lt;/table&gt;
3921
- * &lt;/body&gt;
3922
- * &lt;/html&gt;
3923
- * @classdesc This class provides methods for managing file drop
3924
- * zones, inputs and upload queue.
3925
- * @api
3926
- * @class ITHit.WebDAV.Client.Upload.Uploader
3927
- * @constructs
3928
- */
3929
- class Uploader {
3930
- /**
3931
- * Collection of associated drop zones.
3932
- * @api
3933
- * @readonly
3934
- * @type { ITHit.WebDAV.Client.Upload.DropZoneCollection }
3935
- */
3936
- readonly DropZones: ITHit.WebDAV.Client.Upload.DropZoneCollection
3937
- /**
3938
- * Collection of associated inputs.
3939
- * @api
3940
- * @readonly
3941
- * @type { ITHit.WebDAV.Client.Upload.InputCollection }
3942
- */
3943
- readonly Inputs: ITHit.WebDAV.Client.Upload.InputCollection
3944
- /**
3945
- * Queue of uploads.
3946
- * @api
3947
- * @readonly
3948
- * @type {ITHit.WebDAV.Client.Upload.Queue}
3949
- */
3950
- readonly Queue: ITHit.WebDAV.Client.Upload.Queue
3951
- /**
3952
- * Default settings for uploads.
3953
- * @api
3954
- * @type { ITHit.WebDAV.Client.Upload.Settings }
3955
- */
3956
- Settings: ITHit.WebDAV.Client.Upload.Settings
3957
- /**
3958
- * Set upload url for drop zones and inputs.
3959
- * @api
3960
- * @param {string} sUrl Url to upload.
3961
- */
3962
- SetUploadUrl(sUrl: string): void;
3963
- /**
3964
- * Get upload url for drop zones and inputs.
3965
- * @api
3966
- * @return {string} Upload url.
3967
- */
3968
- GetUploadUrl(): string;
3969
- }
3970
- namespace Controls{
3971
- /**
3972
- * @api
3973
- * Instance of this class provides binding for HTMLElement.
3974
- * @class ITHit.WebDAV.Client.Upload.Controls.HtmlControl
3975
- */
3976
- class HtmlControl {
3977
- /**
3978
- * Id attribute.
3979
- * @api
3980
- * @type {string}
3981
- */
3982
- Id: string
3983
- /**
3984
- * Associated HTML Element
3985
- * @api
3986
- * @type {HTMLElement}
3987
- */
3988
- HtmlElement: HTMLElement
3989
- /**
3990
- * Add event handlers.
3991
- * @public
3992
- * @param {string} sEventName The event name to handle.
3993
- * @param {Function} fCallback The callback to call.
3994
- * @param {Object} [oContext] The context to callback is called with.
3995
- */
3996
- AddListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
3997
- /**
3998
- * Removes event listener.
3999
- * @public
4000
- * @param {string} sEventName The event name to remove.
4001
- * @param {Function} fCallback The callback to remove.
4002
- * @param {Object} [oContext] The context to callback is called with.
4003
- */
4004
- RemoveListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
4005
- /**
4006
- * Event reporting that file handling finished..
4007
- * @public
4008
- * @event ITHit.WebDAV.Client.Upload.Controls.HtmlControl#OnFileInputHandled
4009
- * @property {ITHit.WebDAV.Client.Upload.Controls.HtmlControl} Source The source of event.
4010
- * @property {ITHit.WebDAV.Client.AsyncResult} AsyncResult Result.
4011
- * @property {ITHit.WebDAV.Client.Upload.FSEntry[]} AsyncResult.Result Current uploader
4012
- */
4013
- }/**
4014
- * This class provides methods for creation of {@link ITHit.WebDAV.Client.Upload.FSEntryFactory}s.
4015
- * @public
4016
- * @class ITHit.WebDAV.Client.Upload.Controls.FSEntryFactory
4017
- */
4018
- class FSEntryFactory {
4019
- }/**
4020
- * Instance of this class provides metadata for drop zone.
4021
- * @api
4022
- * @class ITHit.WebDAV.Client.Upload.Controls.DropZone
4023
- * @extends ITHit.WebDAV.Client.Upload.Controls.HtmlControl
4024
- */
4025
- class DropZone extends ITHit.WebDAV.Client.Upload.Controls.HtmlControl {
4026
- /**
4027
- * Id attribute.
4028
- * @api
4029
- * @type {string}
4030
- */
4031
- Id: string
4032
- /**
4033
- * Associated HTML Element
4034
- * @api
4035
- * @type {HTMLElement}
4036
- */
4037
- HtmlElement: HTMLElement
4038
- /**
4039
- * Add event handlers.
4040
- * @public
4041
- * @param {string} sEventName The event name to handle.
4042
- * @param {Function} fCallback The callback to call.
4043
- * @param {Object} [oContext] The context to callback is called with.
4044
- */
4045
- AddListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
4046
- /**
4047
- * Removes event listener.
4048
- * @public
4049
- * @param {string} sEventName The event name to remove.
4050
- * @param {Function} fCallback The callback to remove.
4051
- * @param {Object} [oContext] The context to callback is called with.
4052
- */
4053
- RemoveListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
4054
- /**
4055
- * Event reporting that file handling finished..
4056
- * @public
4057
- * @event ITHit.WebDAV.Client.Upload.Controls.HtmlControl#OnFileInputHandled
4058
- * @property {ITHit.WebDAV.Client.Upload.Controls.HtmlControl} Source The source of event.
4059
- * @property {ITHit.WebDAV.Client.AsyncResult} AsyncResult Result.
4060
- * @property {ITHit.WebDAV.Client.Upload.FSEntry[]} AsyncResult.Result Current uploader
4061
- */
4062
- }/**
4063
- * Instance of this class provides metadata for input.
4064
- * @class ITHit.WebDAV.Client.Upload.Controls.Input
4065
- * @extends ITHit.WebDAV.Client.Upload.Controls.HtmlControl
4066
- * @api
4067
- */
4068
- class Input extends ITHit.WebDAV.Client.Upload.Controls.HtmlControl {
4069
- /**
4070
- * Id attribute.
4071
- * @api
4072
- * @type {string}
4073
- */
4074
- Id: string
4075
- /**
4076
- * Associated HTML Element
4077
- * @api
4078
- * @type {HTMLElement}
4079
- */
4080
- HtmlElement: HTMLElement
4081
- /**
4082
- * Add event handlers.
4083
- * @public
4084
- * @param {string} sEventName The event name to handle.
4085
- * @param {Function} fCallback The callback to call.
4086
- * @param {Object} [oContext] The context to callback is called with.
4087
- */
4088
- AddListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
4089
- /**
4090
- * Removes event listener.
4091
- * @public
4092
- * @param {string} sEventName The event name to remove.
4093
- * @param {Function} fCallback The callback to remove.
4094
- * @param {Object} [oContext] The context to callback is called with.
4095
- */
4096
- RemoveListener(sEventName: string, fCallback: Function, oContext?: Object | null): void;
4097
- /**
4098
- * Event reporting that file handling finished..
4099
- * @public
4100
- * @event ITHit.WebDAV.Client.Upload.Controls.HtmlControl#OnFileInputHandled
4101
- * @property {ITHit.WebDAV.Client.Upload.Controls.HtmlControl} Source The source of event.
4102
- * @property {ITHit.WebDAV.Client.AsyncResult} AsyncResult Result.
4103
- * @property {ITHit.WebDAV.Client.Upload.FSEntry[]} AsyncResult.Result Current uploader
4104
- */
4105
- }}
4106
- namespace Groups{
4107
- /**
4108
- * @public
4109
- * @class ITHit.WebDAV.Client.Upload.Groups.GroupManager
4110
- */
4111
- class GroupManager {
4112
- }}
4113
- namespace Events{
4114
- /**
4115
- * @class ITHit.WebDAV.Client.Upload.Events.BaseEvent
4116
- * @public
4117
- * @abstract
4118
- */
4119
- class BaseEvent {
4120
- /**
4121
- * Event name.
4122
- * @public
4123
- * @type {string}
4124
- */
4125
- Name: string
4126
- /**
4127
- * Event source.
4128
- * @public
4129
- * @type {Object}
4130
- */
4131
- Sender: Object
4132
- }/**
4133
- * This class provides state change event data;
4134
- * @api
4135
- * @class ITHit.WebDAV.Client.Upload.Events.StateChanged
4136
- * @extends ITHit.WebDAV.Client.Upload.Events.BaseEvent
4137
- */
4138
- class StateChanged extends ITHit.WebDAV.Client.Upload.Events.BaseEvent {
4139
- /**
4140
- * Previous state.
4141
- * @api
4142
- * @type {ITHit.WebDAV.Client.Upload.State}
4143
- */
4144
- OldState: ITHit.WebDAV.Client.Upload.State
4145
- /**
4146
- * Actual state.
4147
- * @api
4148
- * @type {ITHit.WebDAV.Client.Upload.State}
4149
- */
4150
- NewState: ITHit.WebDAV.Client.Upload.State
4151
- /**
4152
- * Event name.
4153
- * @public
4154
- * @type {string}
4155
- */
4156
- Name: string
4157
- /**
4158
- * Event source.
4159
- * @public
4160
- * @type {Object}
4161
- */
4162
- Sender: Object
4163
- }/**
4164
- * This class provides state change event data;
4165
- * @api
4166
- * @class ITHit.WebDAV.Client.Upload.Events.ProgressChanged
4167
- * @extends ITHit.WebDAV.Client.Upload.Events.BaseEvent
4168
- */
4169
- class ProgressChanged extends ITHit.WebDAV.Client.Upload.Events.BaseEvent {
4170
- /**
4171
- * Previous progress.
4172
- * @api
4173
- * @type {ITHit.WebDAV.Client.Upload.Progress}
4174
- */
4175
- OldProgress: ITHit.WebDAV.Client.Upload.Progress
4176
- /**
4177
- * Actual progress.
4178
- * @api
4179
- * @type {ITHit.WebDAV.Client.Upload.Progress}
4180
- */
4181
- NewProgress: ITHit.WebDAV.Client.Upload.Progress
4182
- /**
4183
- * Event name.
4184
- * @public
4185
- * @type {string}
4186
- */
4187
- Name: string
4188
- /**
4189
- * Event source.
4190
- * @public
4191
- * @type {Object}
4192
- */
4193
- Sender: Object
4194
- }/**
4195
- * @api
4196
- * This object represent base class for parameters of events that is waiting for user action.
4197
- * @class ITHit.WebDAV.Client.Upload.Events.AsyncEvent
4198
- * @extends ITHit.WebDAV.Client.Upload.Events.BaseEvent
4199
- */
4200
- class AsyncEvent extends ITHit.WebDAV.Client.Upload.Events.BaseEvent {
4201
- /**
4202
- * Event name.
4203
- * @api
4204
- * @type {string}
4205
- */
4206
- Name: string
4207
- /**
4208
- * Event source.
4209
- * @api
4210
- * @type {Object}
4211
- */
4212
- Sender: Object
4213
- /**
4214
- * This methods return value that indicates that event already processed.
4215
- * @api
4216
- * @return {boolean} - True if event was processed, false otherwise.
4217
- */
4218
- GetIsHandled(): boolean;
4219
- }/**
4220
- * This object is passed to {@link ITHit.WebDAV.Client.Upload.UploadItem#event:OnBeforeUploadStarted}.
4221
- * You can validate these item as well as specify if item should be overwritten.
4222
- * To continue upload the {@link ITHit.WebDAV.Client.Upload.Events.BeforeUploadStarted#Upload} function should be called.
4223
- * To skip upload the {@link ITHit.WebDAV.Client.Upload.Events.BeforeUploadStarted#Skip} function should be called.
4224
- * @api
4225
- * @class ITHit.WebDAV.Client.Upload.Events.BeforeUploadStarted
4226
- * @extends ITHit.WebDAV.Client.Upload.Events.AsyncEvent
4227
- */
4228
- class BeforeUploadStarted extends ITHit.WebDAV.Client.Upload.Events.AsyncEvent {
4229
- /**
4230
- * Change item state to {@link ITHit.WebDAV.Client.Upload.State.Skipped}.
4231
- * @api
4232
- */
4233
- Skip(): void;
4234
- /**
4235
- * Continues items upload.
4236
- * If item should not upload call {@link ITHit.WebDAV.Client.Upload.Events.BeforeUploadStarted#Skip} method.
4237
- * If any items in the upload list should be overwritten call {@link ITHit.WebDAV.Client.Upload.UploadItem#SetOverwrite(true)} on item.
4238
- * @api
4239
- */
4240
- Upload(): void;
4241
- /**
4242
- * Event name.
4243
- * @api
4244
- * @type {string}
4245
- */
4246
- Name: string
4247
- /**
4248
- * Event source.
4249
- * @api
4250
- * @type {Object}
4251
- */
4252
- Sender: Object
4253
- /**
4254
- * This methods return value that indicates that event already processed.
4255
- * @api
4256
- * @return {boolean} - True if event was processed, false otherwise.
4257
- */
4258
- GetIsHandled(): boolean;
4259
- }/**
4260
- * @api
4261
- * @class ITHit.WebDAV.Client.Upload.Events.QueueChanged
4262
- * @extends ITHit.WebDAV.Client.Upload.Events.BaseEvent
4263
- */
4264
- class QueueChanged extends ITHit.WebDAV.Client.Upload.Events.BaseEvent {
4265
- /**
4266
- * Added items.
4267
- * @api
4268
- * @type {ITHit.WebDAV.Client.Upload.UploadItem[]}
4269
- */
4270
- AddedItems: ITHit.WebDAV.Client.Upload.UploadItem[]
4271
- /**
4272
- * Removed items.
4273
- * @api
4274
- * @type {ITHit.WebDAV.Client.Upload.UploadItem[]}
4275
- */
4276
- RemovedItems: ITHit.WebDAV.Client.Upload.UploadItem[]
4277
- /**
4278
- * Event name.
4279
- * @public
4280
- * @type {string}
4281
- */
4282
- Name: string
4283
- /**
4284
- * Event source.
4285
- * @public
4286
- * @type {Object}
4287
- */
4288
- Sender: Object
4289
- }/**
4290
- * @api
4291
- * @alias ITHit.WebDAV.Client.Upload.Events.UploadError
4292
- * @extends ITHit.WebDAV.Client.Upload.Events.AsyncEvent
4293
- * @constructs
4294
- * @param {ITHit.WebDAV.Client.Upload.UploadItem} oSender
4295
- * @param {Error|ITHit.WebDAV.Client.Exceptions.WebDavException} oError
4296
- * @param {ITHit.WebDAV.Client.Upload.Events.UploadError~ResultCallback} fCallback
4297
- */
4298
- class UploadError extends ITHit.WebDAV.Client.Upload.Events.AsyncEvent {
4299
- constructor(oSender: ITHit.WebDAV.Client.Upload.UploadItem, oError: Error | ITHit.WebDAV.Client.Exceptions.WebDavException, fCallback?: (oResult: string) => void | null);
4300
- /**
4301
- * Error object.
4302
- * @api
4303
- * @type {Error|ITHit.WebDAV.Client.Exceptions.WebDavException}
4304
- */
4305
- Error: Error | ITHit.WebDAV.Client.Exceptions.WebDavException
4306
- /**
4307
- * Skips retry. UploadItem becomes failed.
4308
- * @api
4309
- */
4310
- Skip(): void;
4311
- /**
4312
- * Retry upload.
4313
- * @api
4314
- */
4315
- Retry(): void;
4316
- /**
4317
- * Event name.
4318
- * @api
4319
- * @type {string}
4320
- */
4321
- Name: string
4322
- /**
4323
- * Event source.
4324
- * @api
4325
- * @type {Object}
4326
- */
4327
- Sender: Object
4328
- /**
4329
- * This methods return value that indicates that event already processed.
4330
- * @api
4331
- * @return {boolean} - True if event was processed, false otherwise.
4332
- */
4333
- GetIsHandled(): boolean;
4334
- }/**
4335
- * This class provides state change event data;
4336
- * @public
4337
- * @class ITHit.WebDAV.Client.Upload.Events.Error
4338
- * @extends ITHit.WebDAV.Client.Upload.Events.BaseEvent
4339
- */
4340
- class Error extends ITHit.WebDAV.Client.Upload.Events.BaseEvent {
4341
- /**
4342
- * Error object.
4343
- * @public
4344
- * @type {Error|ITHit.WebDAV.Client.Exceptions.WebDavException}
4345
- */
4346
- Error: Error | ITHit.WebDAV.Client.Exceptions.WebDavException
4347
- /**
4348
- * Event name.
4349
- * @public
4350
- * @type {string}
4351
- */
4352
- Name: string
4353
- /**
4354
- * Event source.
4355
- * @public
4356
- * @type {Object}
4357
- */
4358
- Sender: Object
4359
- }/**
4360
- * This object is passed to {@link ITHit.WebDAV.Client.Upload.Queue#event:OnUploadItemsCreated} and contains list of items selected by user for upload.
4361
- * You can validate these items as well as specify if item should be overwritten.
4362
- * To continue upload the UploadItemsCreated.Upload() function with the list of items to be uploaded should be called.
4363
- * @api
4364
- * @alias ITHit.WebDAV.Client.Upload.Events.UploadItemsCreated
4365
- * @extends ITHit.WebDAV.Client.Upload.Events.AsyncEvent
4366
- * @constructs
4367
- * @param {ITHit.WebDAV.Client.Upload.UploadItem} oSender
4368
- * @param {ITHit.WebDAV.Client.Upload.UploadItem[]} aItems
4369
- * @param {ITHit.WebDAV.Client.Upload.Events.UploadItemsCreated~ResultCallback} fCallback
4370
- */
4371
- class UploadItemsCreated extends ITHit.WebDAV.Client.Upload.Events.AsyncEvent {
4372
- constructor(oSender: ITHit.WebDAV.Client.Upload.UploadItem, aItems: ITHit.WebDAV.Client.Upload.UploadItem[], fCallback?: (oResult?: () => void | null) => void);
4373
- /**
4374
- * Added items.
4375
- * @api
4376
- * @type {ITHit.WebDAV.Client.Upload.UploadItem[]}
4377
- */
4378
- Items: ITHit.WebDAV.Client.Upload.UploadItem[]
4379
- /**
4380
- * Continues items upload. Pass a list of items to upload.
4381
- * If any items should not upload do not include them in this list.
4382
- * If any items in the upload list should be overwritten call {@link ITHit.WebDAV.Client.Upload.UploadItem#SetOverwrite(true)}) on each item.
4383
- * @api
4384
- * @param {ITHit.WebDAV.Client.Upload.UploadItem[]} aItems - The list of items to be uploaded. Items not listed here will be skipped.
4385
- */
4386
- Upload(aItems: ITHit.WebDAV.Client.Upload.UploadItem[]): void;
4387
- /**
4388
- * Event name.
4389
- * @api
4390
- * @type {string}
4391
- */
4392
- Name: string
4393
- /**
4394
- * Event source.
4395
- * @api
4396
- * @type {Object}
4397
- */
4398
- Sender: Object
4399
- /**
4400
- * This methods return value that indicates that event already processed.
4401
- * @api
4402
- * @return {boolean} - True if event was processed, false otherwise.
4403
- */
4404
- GetIsHandled(): boolean;
4405
- }}}}class Client {
4406
- /**
4407
- * License Id
4408
- * @public
4409
- * @name ITHit.WebDAV.Client.LicenseId
4410
- * @type {string}
4411
- */
4412
- static LicenseId: string
4413
- LicenseId: string
4414
- }}}