@chilkat/react-native 11.6.1

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.
Files changed (530) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/ChilkatRN.podspec +44 -0
  3. package/LICENSE +254 -0
  4. package/README.md +67 -0
  5. package/android/CMakeLists.txt +60 -0
  6. package/android/build.gradle +148 -0
  7. package/android/gradle.properties +5 -0
  8. package/android/src/main/AndroidManifest.xml +2 -0
  9. package/android/src/main/cpp/cpp-adapter.cpp +12 -0
  10. package/android/src/main/java/com/margelo/nitro/chilkat/ChilkatRNPackage.java +33 -0
  11. package/chilkat-checksums.json +9 -0
  12. package/cpp/HybridAi.cpp +660 -0
  13. package/cpp/HybridAi.hpp +159 -0
  14. package/cpp/HybridAsn.cpp +403 -0
  15. package/cpp/HybridAsn.hpp +105 -0
  16. package/cpp/HybridAuthAws.cpp +188 -0
  17. package/cpp/HybridAuthAws.hpp +55 -0
  18. package/cpp/HybridAuthAzureSAS.cpp +142 -0
  19. package/cpp/HybridAuthAzureSAS.hpp +47 -0
  20. package/cpp/HybridAuthAzureStorage.cpp +144 -0
  21. package/cpp/HybridAuthAzureStorage.hpp +47 -0
  22. package/cpp/HybridAuthGoogle.cpp +215 -0
  23. package/cpp/HybridAuthGoogle.hpp +67 -0
  24. package/cpp/HybridBinData.cpp +439 -0
  25. package/cpp/HybridBinData.hpp +112 -0
  26. package/cpp/HybridBz2.cpp +177 -0
  27. package/cpp/HybridBz2.hpp +58 -0
  28. package/cpp/HybridCache.cpp +314 -0
  29. package/cpp/HybridCache.hpp +82 -0
  30. package/cpp/HybridCert.cpp +840 -0
  31. package/cpp/HybridCert.hpp +196 -0
  32. package/cpp/HybridCertChain.cpp +149 -0
  33. package/cpp/HybridCertChain.hpp +50 -0
  34. package/cpp/HybridCertStore.cpp +276 -0
  35. package/cpp/HybridCertStore.hpp +78 -0
  36. package/cpp/HybridCharset.cpp +333 -0
  37. package/cpp/HybridCharset.hpp +83 -0
  38. package/cpp/HybridCkDateTime.cpp +384 -0
  39. package/cpp/HybridCkDateTime.hpp +105 -0
  40. package/cpp/HybridCodeSign.cpp +156 -0
  41. package/cpp/HybridCodeSign.hpp +55 -0
  42. package/cpp/HybridCompression.cpp +422 -0
  43. package/cpp/HybridCompression.hpp +100 -0
  44. package/cpp/HybridCrypt2.cpp +1517 -0
  45. package/cpp/HybridCrypt2.hpp +320 -0
  46. package/cpp/HybridCsr.cpp +292 -0
  47. package/cpp/HybridCsr.hpp +77 -0
  48. package/cpp/HybridCsv.cpp +382 -0
  49. package/cpp/HybridCsv.hpp +101 -0
  50. package/cpp/HybridDh.cpp +137 -0
  51. package/cpp/HybridDh.hpp +47 -0
  52. package/cpp/HybridDirTree.cpp +167 -0
  53. package/cpp/HybridDirTree.hpp +53 -0
  54. package/cpp/HybridDkim.cpp +249 -0
  55. package/cpp/HybridDkim.hpp +74 -0
  56. package/cpp/HybridDns.cpp +193 -0
  57. package/cpp/HybridDns.hpp +64 -0
  58. package/cpp/HybridDsa.cpp +453 -0
  59. package/cpp/HybridDsa.hpp +112 -0
  60. package/cpp/HybridDtObj.cpp +172 -0
  61. package/cpp/HybridDtObj.hpp +57 -0
  62. package/cpp/HybridEcc.cpp +195 -0
  63. package/cpp/HybridEcc.hpp +55 -0
  64. package/cpp/HybridEdDSA.cpp +147 -0
  65. package/cpp/HybridEdDSA.hpp +47 -0
  66. package/cpp/HybridEmail.cpp +1911 -0
  67. package/cpp/HybridEmail.hpp +419 -0
  68. package/cpp/HybridEmailBundle.cpp +204 -0
  69. package/cpp/HybridEmailBundle.hpp +64 -0
  70. package/cpp/HybridFileAccess.cpp +631 -0
  71. package/cpp/HybridFileAccess.hpp +149 -0
  72. package/cpp/HybridFtp2.cpp +2308 -0
  73. package/cpp/HybridFtp2.hpp +462 -0
  74. package/cpp/HybridGlobal.cpp +221 -0
  75. package/cpp/HybridGlobal.hpp +68 -0
  76. package/cpp/HybridGzip.cpp +440 -0
  77. package/cpp/HybridGzip.hpp +105 -0
  78. package/cpp/HybridHashtable.cpp +211 -0
  79. package/cpp/HybridHashtable.hpp +64 -0
  80. package/cpp/HybridHtmlToText.cpp +136 -0
  81. package/cpp/HybridHtmlToText.hpp +47 -0
  82. package/cpp/HybridHtmlToXml.cpp +218 -0
  83. package/cpp/HybridHtmlToXml.hpp +65 -0
  84. package/cpp/HybridHttp.cpp +2067 -0
  85. package/cpp/HybridHttp.hpp +416 -0
  86. package/cpp/HybridHttpCurl.cpp +337 -0
  87. package/cpp/HybridHttpCurl.hpp +93 -0
  88. package/cpp/HybridHttpRequest.cpp +455 -0
  89. package/cpp/HybridHttpRequest.hpp +109 -0
  90. package/cpp/HybridHttpResponse.cpp +340 -0
  91. package/cpp/HybridHttpResponse.hpp +86 -0
  92. package/cpp/HybridImap.cpp +1818 -0
  93. package/cpp/HybridImap.hpp +363 -0
  94. package/cpp/HybridJavaKeyStore.cpp +387 -0
  95. package/cpp/HybridJavaKeyStore.hpp +98 -0
  96. package/cpp/HybridJs.cpp +154 -0
  97. package/cpp/HybridJs.hpp +54 -0
  98. package/cpp/HybridJsonArray.cpp +441 -0
  99. package/cpp/HybridJsonArray.hpp +120 -0
  100. package/cpp/HybridJsonObject.cpp +1125 -0
  101. package/cpp/HybridJsonObject.hpp +260 -0
  102. package/cpp/HybridJwe.cpp +294 -0
  103. package/cpp/HybridJwe.hpp +82 -0
  104. package/cpp/HybridJws.cpp +290 -0
  105. package/cpp/HybridJws.hpp +82 -0
  106. package/cpp/HybridJwt.cpp +198 -0
  107. package/cpp/HybridJwt.hpp +57 -0
  108. package/cpp/HybridLog.cpp +212 -0
  109. package/cpp/HybridLog.hpp +63 -0
  110. package/cpp/HybridMailMan.cpp +1853 -0
  111. package/cpp/HybridMailMan.hpp +386 -0
  112. package/cpp/HybridMailboxes.cpp +165 -0
  113. package/cpp/HybridMailboxes.hpp +54 -0
  114. package/cpp/HybridMcp.cpp +322 -0
  115. package/cpp/HybridMcp.hpp +85 -0
  116. package/cpp/HybridMessageSet.cpp +162 -0
  117. package/cpp/HybridMessageSet.hpp +54 -0
  118. package/cpp/HybridMht.cpp +700 -0
  119. package/cpp/HybridMht.hpp +165 -0
  120. package/cpp/HybridMime.cpp +1119 -0
  121. package/cpp/HybridMime.hpp +266 -0
  122. package/cpp/HybridNtlm.cpp +333 -0
  123. package/cpp/HybridNtlm.hpp +83 -0
  124. package/cpp/HybridOAuth1.cpp +307 -0
  125. package/cpp/HybridOAuth1.hpp +78 -0
  126. package/cpp/HybridOAuth2.cpp +515 -0
  127. package/cpp/HybridOAuth2.hpp +127 -0
  128. package/cpp/HybridPdf.cpp +370 -0
  129. package/cpp/HybridPdf.hpp +103 -0
  130. package/cpp/HybridPem.cpp +327 -0
  131. package/cpp/HybridPem.hpp +88 -0
  132. package/cpp/HybridPfx.cpp +343 -0
  133. package/cpp/HybridPfx.hpp +87 -0
  134. package/cpp/HybridPkcs11.cpp +318 -0
  135. package/cpp/HybridPkcs11.hpp +88 -0
  136. package/cpp/HybridPrivateKey.cpp +464 -0
  137. package/cpp/HybridPrivateKey.hpp +117 -0
  138. package/cpp/HybridPrng.cpp +192 -0
  139. package/cpp/HybridPrng.hpp +57 -0
  140. package/cpp/HybridPublicKey.cpp +238 -0
  141. package/cpp/HybridPublicKey.hpp +68 -0
  142. package/cpp/HybridRest.cpp +993 -0
  143. package/cpp/HybridRest.hpp +214 -0
  144. package/cpp/HybridRsa.cpp +348 -0
  145. package/cpp/HybridRsa.hpp +90 -0
  146. package/cpp/HybridSCard.cpp +328 -0
  147. package/cpp/HybridSCard.hpp +91 -0
  148. package/cpp/HybridSFtp.cpp +1889 -0
  149. package/cpp/HybridSFtp.hpp +366 -0
  150. package/cpp/HybridSFtpDir.cpp +119 -0
  151. package/cpp/HybridSFtpDir.hpp +43 -0
  152. package/cpp/HybridSFtpFile.cpp +203 -0
  153. package/cpp/HybridSFtpFile.hpp +60 -0
  154. package/cpp/HybridScMinidriver.cpp +341 -0
  155. package/cpp/HybridScMinidriver.hpp +88 -0
  156. package/cpp/HybridScp.cpp +398 -0
  157. package/cpp/HybridScp.hpp +96 -0
  158. package/cpp/HybridSecrets.cpp +328 -0
  159. package/cpp/HybridSecrets.hpp +84 -0
  160. package/cpp/HybridSecureString.cpp +175 -0
  161. package/cpp/HybridSecureString.hpp +55 -0
  162. package/cpp/HybridServerSentEvent.cpp +112 -0
  163. package/cpp/HybridServerSentEvent.hpp +41 -0
  164. package/cpp/HybridSocket.cpp +1567 -0
  165. package/cpp/HybridSocket.hpp +336 -0
  166. package/cpp/HybridSpider.cpp +543 -0
  167. package/cpp/HybridSpider.hpp +138 -0
  168. package/cpp/HybridSsh.cpp +1330 -0
  169. package/cpp/HybridSsh.hpp +282 -0
  170. package/cpp/HybridSshKey.cpp +310 -0
  171. package/cpp/HybridSshKey.hpp +83 -0
  172. package/cpp/HybridSshTunnel.cpp +687 -0
  173. package/cpp/HybridSshTunnel.hpp +159 -0
  174. package/cpp/HybridStream.cpp +496 -0
  175. package/cpp/HybridStream.hpp +123 -0
  176. package/cpp/HybridStringArray.cpp +368 -0
  177. package/cpp/HybridStringArray.hpp +99 -0
  178. package/cpp/HybridStringBuilder.cpp +739 -0
  179. package/cpp/HybridStringBuilder.hpp +178 -0
  180. package/cpp/HybridStringTable.cpp +218 -0
  181. package/cpp/HybridStringTable.hpp +66 -0
  182. package/cpp/HybridTar.cpp +547 -0
  183. package/cpp/HybridTar.hpp +134 -0
  184. package/cpp/HybridTrustedRoots.cpp +178 -0
  185. package/cpp/HybridTrustedRoots.hpp +61 -0
  186. package/cpp/HybridUnixCompress.cpp +191 -0
  187. package/cpp/HybridUnixCompress.hpp +60 -0
  188. package/cpp/HybridUpload.cpp +427 -0
  189. package/cpp/HybridUpload.hpp +114 -0
  190. package/cpp/HybridUrl.cpp +152 -0
  191. package/cpp/HybridUrl.hpp +48 -0
  192. package/cpp/HybridWebSocket.cpp +378 -0
  193. package/cpp/HybridWebSocket.hpp +103 -0
  194. package/cpp/HybridXml.cpp +1527 -0
  195. package/cpp/HybridXml.hpp +340 -0
  196. package/cpp/HybridXmlCertVault.cpp +215 -0
  197. package/cpp/HybridXmlCertVault.hpp +63 -0
  198. package/cpp/HybridXmlDSig.cpp +328 -0
  199. package/cpp/HybridXmlDSig.hpp +88 -0
  200. package/cpp/HybridXmlDSigGen.cpp +549 -0
  201. package/cpp/HybridXmlDSigGen.hpp +126 -0
  202. package/cpp/HybridXmp.cpp +329 -0
  203. package/cpp/HybridXmp.hpp +86 -0
  204. package/cpp/HybridZip.cpp +1000 -0
  205. package/cpp/HybridZip.hpp +226 -0
  206. package/cpp/HybridZipCrc.cpp +162 -0
  207. package/cpp/HybridZipCrc.hpp +57 -0
  208. package/cpp/HybridZipEntry.cpp +395 -0
  209. package/cpp/HybridZipEntry.hpp +102 -0
  210. package/cpp/runtime/AsyncCall.hpp +96 -0
  211. package/cpp/runtime/Bytes.hpp +49 -0
  212. package/cpp/runtime/ChilkatError.hpp +66 -0
  213. package/cpp/runtime/ChilkatObject.hpp +219 -0
  214. package/cpp/runtime/ProgLang.hpp +9 -0
  215. package/cpp/runtime/ProgressAdapter.hpp +43 -0
  216. package/nitro.json +113 -0
  217. package/nitrogen/generated/.gitattributes +1 -0
  218. package/nitrogen/generated/android/ChilkatRN+autolinking.cmake +179 -0
  219. package/nitrogen/generated/android/ChilkatRN+autolinking.gradle +27 -0
  220. package/nitrogen/generated/android/ChilkatRNOnLoad.cpp +1029 -0
  221. package/nitrogen/generated/android/ChilkatRNOnLoad.hpp +34 -0
  222. package/nitrogen/generated/android/kotlin/com/margelo/nitro/chilkat/ChilkatRNOnLoad.kt +35 -0
  223. package/nitrogen/generated/ios/ChilkatRN+autolinking.rb +62 -0
  224. package/nitrogen/generated/ios/ChilkatRN-Swift-Cxx-Bridge.cpp +17 -0
  225. package/nitrogen/generated/ios/ChilkatRN-Swift-Cxx-Bridge.hpp +27 -0
  226. package/nitrogen/generated/ios/ChilkatRN-Swift-Cxx-Umbrella.hpp +38 -0
  227. package/nitrogen/generated/ios/ChilkatRNAutolinking.mm +1015 -0
  228. package/nitrogen/generated/ios/ChilkatRNAutolinking.swift +16 -0
  229. package/nitrogen/generated/shared/c++/HybridAiSpec.cpp +114 -0
  230. package/nitrogen/generated/shared/c++/HybridAiSpec.hpp +175 -0
  231. package/nitrogen/generated/shared/c++/HybridAsnSpec.cpp +70 -0
  232. package/nitrogen/generated/shared/c++/HybridAsnSpec.hpp +116 -0
  233. package/nitrogen/generated/shared/c++/HybridAuthAwsSpec.cpp +49 -0
  234. package/nitrogen/generated/shared/c++/HybridAuthAwsSpec.hpp +89 -0
  235. package/nitrogen/generated/shared/c++/HybridAuthAzureSASSpec.cpp +38 -0
  236. package/nitrogen/generated/shared/c++/HybridAuthAzureSASSpec.hpp +78 -0
  237. package/nitrogen/generated/shared/c++/HybridAuthAzureStorageSpec.cpp +41 -0
  238. package/nitrogen/generated/shared/c++/HybridAuthAzureStorageSpec.hpp +81 -0
  239. package/nitrogen/generated/shared/c++/HybridAuthGoogleSpec.cpp +56 -0
  240. package/nitrogen/generated/shared/c++/HybridAuthGoogleSpec.hpp +108 -0
  241. package/nitrogen/generated/shared/c++/HybridBinDataSpec.cpp +69 -0
  242. package/nitrogen/generated/shared/c++/HybridBinDataSpec.hpp +116 -0
  243. package/nitrogen/generated/shared/c++/HybridBz2Spec.cpp +47 -0
  244. package/nitrogen/generated/shared/c++/HybridBz2Spec.hpp +93 -0
  245. package/nitrogen/generated/shared/c++/HybridCacheSpec.cpp +57 -0
  246. package/nitrogen/generated/shared/c++/HybridCacheSpec.hpp +106 -0
  247. package/nitrogen/generated/shared/c++/HybridCertChainSpec.cpp +40 -0
  248. package/nitrogen/generated/shared/c++/HybridCertChainSpec.hpp +89 -0
  249. package/nitrogen/generated/shared/c++/HybridCertSpec.cpp +138 -0
  250. package/nitrogen/generated/shared/c++/HybridCertSpec.hpp +205 -0
  251. package/nitrogen/generated/shared/c++/HybridCertStoreSpec.cpp +55 -0
  252. package/nitrogen/generated/shared/c++/HybridCertStoreSpec.hpp +104 -0
  253. package/nitrogen/generated/shared/c++/HybridCharsetSpec.cpp +61 -0
  254. package/nitrogen/generated/shared/c++/HybridCharsetSpec.hpp +101 -0
  255. package/nitrogen/generated/shared/c++/HybridCkDateTimeSpec.cpp +66 -0
  256. package/nitrogen/generated/shared/c++/HybridCkDateTimeSpec.hpp +115 -0
  257. package/nitrogen/generated/shared/c++/HybridCodeSignSpec.cpp +44 -0
  258. package/nitrogen/generated/shared/c++/HybridCodeSignSpec.hpp +93 -0
  259. package/nitrogen/generated/shared/c++/HybridCompressionSpec.cpp +79 -0
  260. package/nitrogen/generated/shared/c++/HybridCompressionSpec.hpp +134 -0
  261. package/nitrogen/generated/shared/c++/HybridCrypt2Spec.cpp +215 -0
  262. package/nitrogen/generated/shared/c++/HybridCrypt2Spec.hpp +283 -0
  263. package/nitrogen/generated/shared/c++/HybridCsrSpec.cpp +61 -0
  264. package/nitrogen/generated/shared/c++/HybridCsrSpec.hpp +116 -0
  265. package/nitrogen/generated/shared/c++/HybridCsvSpec.cpp +72 -0
  266. package/nitrogen/generated/shared/c++/HybridCsvSpec.hpp +121 -0
  267. package/nitrogen/generated/shared/c++/HybridDhSpec.cpp +37 -0
  268. package/nitrogen/generated/shared/c++/HybridDhSpec.hpp +77 -0
  269. package/nitrogen/generated/shared/c++/HybridDirTreeSpec.cpp +46 -0
  270. package/nitrogen/generated/shared/c++/HybridDirTreeSpec.hpp +86 -0
  271. package/nitrogen/generated/shared/c++/HybridDkimSpec.cpp +60 -0
  272. package/nitrogen/generated/shared/c++/HybridDkimSpec.hpp +109 -0
  273. package/nitrogen/generated/shared/c++/HybridDnsSpec.cpp +51 -0
  274. package/nitrogen/generated/shared/c++/HybridDnsSpec.hpp +97 -0
  275. package/nitrogen/generated/shared/c++/HybridDsaSpec.cpp +73 -0
  276. package/nitrogen/generated/shared/c++/HybridDsaSpec.hpp +116 -0
  277. package/nitrogen/generated/shared/c++/HybridDtObjSpec.cpp +50 -0
  278. package/nitrogen/generated/shared/c++/HybridDtObjSpec.hpp +90 -0
  279. package/nitrogen/generated/shared/c++/HybridEccSpec.cpp +41 -0
  280. package/nitrogen/generated/shared/c++/HybridEccSpec.hpp +96 -0
  281. package/nitrogen/generated/shared/c++/HybridEdDSASpec.cpp +38 -0
  282. package/nitrogen/generated/shared/c++/HybridEdDSASpec.hpp +90 -0
  283. package/nitrogen/generated/shared/c++/HybridEmailBundleSpec.cpp +45 -0
  284. package/nitrogen/generated/shared/c++/HybridEmailBundleSpec.hpp +91 -0
  285. package/nitrogen/generated/shared/c++/HybridEmailSpec.cpp +259 -0
  286. package/nitrogen/generated/shared/c++/HybridEmailSpec.hpp +326 -0
  287. package/nitrogen/generated/shared/c++/HybridFileAccessSpec.cpp +90 -0
  288. package/nitrogen/generated/shared/c++/HybridFileAccessSpec.hpp +140 -0
  289. package/nitrogen/generated/shared/c++/HybridFtp2Spec.cpp +367 -0
  290. package/nitrogen/generated/shared/c++/HybridFtp2Spec.hpp +434 -0
  291. package/nitrogen/generated/shared/c++/HybridGlobalSpec.cpp +59 -0
  292. package/nitrogen/generated/shared/c++/HybridGlobalSpec.hpp +99 -0
  293. package/nitrogen/generated/shared/c++/HybridGzipSpec.cpp +79 -0
  294. package/nitrogen/generated/shared/c++/HybridGzipSpec.hpp +134 -0
  295. package/nitrogen/generated/shared/c++/HybridHashtableSpec.cpp +45 -0
  296. package/nitrogen/generated/shared/c++/HybridHashtableSpec.hpp +91 -0
  297. package/nitrogen/generated/shared/c++/HybridHtmlToTextSpec.cpp +40 -0
  298. package/nitrogen/generated/shared/c++/HybridHtmlToTextSpec.hpp +83 -0
  299. package/nitrogen/generated/shared/c++/HybridHtmlToXmlSpec.cpp +49 -0
  300. package/nitrogen/generated/shared/c++/HybridHtmlToXmlSpec.hpp +95 -0
  301. package/nitrogen/generated/shared/c++/HybridHttpCurlSpec.cpp +67 -0
  302. package/nitrogen/generated/shared/c++/HybridHttpCurlSpec.hpp +125 -0
  303. package/nitrogen/generated/shared/c++/HybridHttpRequestSpec.cpp +76 -0
  304. package/nitrogen/generated/shared/c++/HybridHttpRequestSpec.hpp +122 -0
  305. package/nitrogen/generated/shared/c++/HybridHttpResponseSpec.cpp +64 -0
  306. package/nitrogen/generated/shared/c++/HybridHttpResponseSpec.hpp +119 -0
  307. package/nitrogen/generated/shared/c++/HybridHttpSpec.cpp +334 -0
  308. package/nitrogen/generated/shared/c++/HybridHttpSpec.hpp +407 -0
  309. package/nitrogen/generated/shared/c++/HybridImapSpec.cpp +275 -0
  310. package/nitrogen/generated/shared/c++/HybridImapSpec.hpp +360 -0
  311. package/nitrogen/generated/shared/c++/HybridJavaKeyStoreSpec.cpp +65 -0
  312. package/nitrogen/generated/shared/c++/HybridJavaKeyStoreSpec.hpp +132 -0
  313. package/nitrogen/generated/shared/c++/HybridJsSpec.cpp +43 -0
  314. package/nitrogen/generated/shared/c++/HybridJsSpec.hpp +92 -0
  315. package/nitrogen/generated/shared/c++/HybridJsonArraySpec.cpp +76 -0
  316. package/nitrogen/generated/shared/c++/HybridJsonArraySpec.hpp +131 -0
  317. package/nitrogen/generated/shared/c++/HybridJsonObjectSpec.cpp +154 -0
  318. package/nitrogen/generated/shared/c++/HybridJsonObjectSpec.hpp +218 -0
  319. package/nitrogen/generated/shared/c++/HybridJweSpec.cpp +57 -0
  320. package/nitrogen/generated/shared/c++/HybridJweSpec.hpp +112 -0
  321. package/nitrogen/generated/shared/c++/HybridJwsSpec.cpp +57 -0
  322. package/nitrogen/generated/shared/c++/HybridJwsSpec.hpp +115 -0
  323. package/nitrogen/generated/shared/c++/HybridJwtSpec.cpp +43 -0
  324. package/nitrogen/generated/shared/c++/HybridJwtSpec.hpp +92 -0
  325. package/nitrogen/generated/shared/c++/HybridLogSpec.cpp +44 -0
  326. package/nitrogen/generated/shared/c++/HybridLogSpec.hpp +85 -0
  327. package/nitrogen/generated/shared/c++/HybridMailManSpec.cpp +311 -0
  328. package/nitrogen/generated/shared/c++/HybridMailManSpec.hpp +396 -0
  329. package/nitrogen/generated/shared/c++/HybridMailboxesSpec.cpp +40 -0
  330. package/nitrogen/generated/shared/c++/HybridMailboxesSpec.hpp +80 -0
  331. package/nitrogen/generated/shared/c++/HybridMcpSpec.cpp +68 -0
  332. package/nitrogen/generated/shared/c++/HybridMcpSpec.hpp +117 -0
  333. package/nitrogen/generated/shared/c++/HybridMessageSetSpec.cpp +41 -0
  334. package/nitrogen/generated/shared/c++/HybridMessageSetSpec.hpp +84 -0
  335. package/nitrogen/generated/shared/c++/HybridMhtSpec.cpp +138 -0
  336. package/nitrogen/generated/shared/c++/HybridMhtSpec.hpp +181 -0
  337. package/nitrogen/generated/shared/c++/HybridMimeSpec.cpp +169 -0
  338. package/nitrogen/generated/shared/c++/HybridMimeSpec.hpp +233 -0
  339. package/nitrogen/generated/shared/c++/HybridNtlmSpec.cpp +69 -0
  340. package/nitrogen/generated/shared/c++/HybridNtlmSpec.hpp +109 -0
  341. package/nitrogen/generated/shared/c++/HybridOAuth1Spec.cpp +67 -0
  342. package/nitrogen/generated/shared/c++/HybridOAuth1Spec.hpp +110 -0
  343. package/nitrogen/generated/shared/c++/HybridOAuth2Spec.cpp +107 -0
  344. package/nitrogen/generated/shared/c++/HybridOAuth2Spec.hpp +156 -0
  345. package/nitrogen/generated/shared/c++/HybridPdfSpec.cpp +73 -0
  346. package/nitrogen/generated/shared/c++/HybridPdfSpec.hpp +134 -0
  347. package/nitrogen/generated/shared/c++/HybridPemSpec.cpp +63 -0
  348. package/nitrogen/generated/shared/c++/HybridPemSpec.hpp +124 -0
  349. package/nitrogen/generated/shared/c++/HybridPfxSpec.cpp +61 -0
  350. package/nitrogen/generated/shared/c++/HybridPfxSpec.hpp +122 -0
  351. package/nitrogen/generated/shared/c++/HybridPkcs11Spec.cpp +60 -0
  352. package/nitrogen/generated/shared/c++/HybridPkcs11Spec.hpp +115 -0
  353. package/nitrogen/generated/shared/c++/HybridPrivateKeySpec.cpp +76 -0
  354. package/nitrogen/generated/shared/c++/HybridPrivateKeySpec.hpp +131 -0
  355. package/nitrogen/generated/shared/c++/HybridPrngSpec.cpp +42 -0
  356. package/nitrogen/generated/shared/c++/HybridPrngSpec.hpp +85 -0
  357. package/nitrogen/generated/shared/c++/HybridPublicKeySpec.cpp +48 -0
  358. package/nitrogen/generated/shared/c++/HybridPublicKeySpec.hpp +91 -0
  359. package/nitrogen/generated/shared/c++/HybridRestSpec.cpp +150 -0
  360. package/nitrogen/generated/shared/c++/HybridRestSpec.hpp +229 -0
  361. package/nitrogen/generated/shared/c++/HybridRsaSpec.cpp +68 -0
  362. package/nitrogen/generated/shared/c++/HybridRsaSpec.hpp +120 -0
  363. package/nitrogen/generated/shared/c++/HybridSCardSpec.cpp +64 -0
  364. package/nitrogen/generated/shared/c++/HybridSCardSpec.hpp +116 -0
  365. package/nitrogen/generated/shared/c++/HybridSFtpDirSpec.cpp +35 -0
  366. package/nitrogen/generated/shared/c++/HybridSFtpDirSpec.hpp +78 -0
  367. package/nitrogen/generated/shared/c++/HybridSFtpFileSpec.cpp +57 -0
  368. package/nitrogen/generated/shared/c++/HybridSFtpFileSpec.hpp +98 -0
  369. package/nitrogen/generated/shared/c++/HybridSFtpSpec.cpp +284 -0
  370. package/nitrogen/generated/shared/c++/HybridSFtpSpec.hpp +354 -0
  371. package/nitrogen/generated/shared/c++/HybridScMinidriverSpec.cpp +61 -0
  372. package/nitrogen/generated/shared/c++/HybridScMinidriverSpec.hpp +119 -0
  373. package/nitrogen/generated/shared/c++/HybridScpSpec.cpp +78 -0
  374. package/nitrogen/generated/shared/c++/HybridScpSpec.hpp +127 -0
  375. package/nitrogen/generated/shared/c++/HybridSecretsSpec.cpp +65 -0
  376. package/nitrogen/generated/shared/c++/HybridSecretsSpec.hpp +120 -0
  377. package/nitrogen/generated/shared/c++/HybridSecureStringSpec.cpp +42 -0
  378. package/nitrogen/generated/shared/c++/HybridSecureStringSpec.hpp +88 -0
  379. package/nitrogen/generated/shared/c++/HybridServerSentEventSpec.cpp +35 -0
  380. package/nitrogen/generated/shared/c++/HybridServerSentEventSpec.hpp +75 -0
  381. package/nitrogen/generated/shared/c++/HybridSocketSpec.cpp +262 -0
  382. package/nitrogen/generated/shared/c++/HybridSocketSpec.hpp +327 -0
  383. package/nitrogen/generated/shared/c++/HybridSpiderSpec.cpp +110 -0
  384. package/nitrogen/generated/shared/c++/HybridSpiderSpec.hpp +153 -0
  385. package/nitrogen/generated/shared/c++/HybridSshKeySpec.cpp +59 -0
  386. package/nitrogen/generated/shared/c++/HybridSshKeySpec.hpp +102 -0
  387. package/nitrogen/generated/shared/c++/HybridSshSpec.cpp +215 -0
  388. package/nitrogen/generated/shared/c++/HybridSshSpec.hpp +276 -0
  389. package/nitrogen/generated/shared/c++/HybridSshTunnelSpec.cpp +136 -0
  390. package/nitrogen/generated/shared/c++/HybridSshTunnelSpec.hpp +191 -0
  391. package/nitrogen/generated/shared/c++/HybridStreamSpec.cpp +100 -0
  392. package/nitrogen/generated/shared/c++/HybridStreamSpec.hpp +150 -0
  393. package/nitrogen/generated/shared/c++/HybridStringArraySpec.cpp +66 -0
  394. package/nitrogen/generated/shared/c++/HybridStringArraySpec.hpp +109 -0
  395. package/nitrogen/generated/shared/c++/HybridStringBuilderSpec.cpp +104 -0
  396. package/nitrogen/generated/shared/c++/HybridStringBuilderSpec.hpp +156 -0
  397. package/nitrogen/generated/shared/c++/HybridStringTableSpec.cpp +46 -0
  398. package/nitrogen/generated/shared/c++/HybridStringTableSpec.hpp +89 -0
  399. package/nitrogen/generated/shared/c++/HybridTarSpec.cpp +110 -0
  400. package/nitrogen/generated/shared/c++/HybridTarSpec.hpp +156 -0
  401. package/nitrogen/generated/shared/c++/HybridTrustedRootsSpec.cpp +48 -0
  402. package/nitrogen/generated/shared/c++/HybridTrustedRootsSpec.hpp +97 -0
  403. package/nitrogen/generated/shared/c++/HybridUnixCompressSpec.cpp +48 -0
  404. package/nitrogen/generated/shared/c++/HybridUnixCompressSpec.hpp +91 -0
  405. package/nitrogen/generated/shared/c++/HybridUploadSpec.cpp +98 -0
  406. package/nitrogen/generated/shared/c++/HybridUploadSpec.hpp +141 -0
  407. package/nitrogen/generated/shared/c++/HybridUrlSpec.cpp +42 -0
  408. package/nitrogen/generated/shared/c++/HybridUrlSpec.hpp +82 -0
  409. package/nitrogen/generated/shared/c++/HybridWebSocketSpec.cpp +80 -0
  410. package/nitrogen/generated/shared/c++/HybridWebSocketSpec.hpp +135 -0
  411. package/nitrogen/generated/shared/c++/HybridXmlCertVaultSpec.cpp +45 -0
  412. package/nitrogen/generated/shared/c++/HybridXmlCertVaultSpec.hpp +94 -0
  413. package/nitrogen/generated/shared/c++/HybridXmlDSigGenSpec.cpp +99 -0
  414. package/nitrogen/generated/shared/c++/HybridXmlDSigGenSpec.hpp +163 -0
  415. package/nitrogen/generated/shared/c++/HybridXmlDSigSpec.cpp +62 -0
  416. package/nitrogen/generated/shared/c++/HybridXmlDSigSpec.hpp +126 -0
  417. package/nitrogen/generated/shared/c++/HybridXmlSpec.cpp +203 -0
  418. package/nitrogen/generated/shared/c++/HybridXmlSpec.hpp +253 -0
  419. package/nitrogen/generated/shared/c++/HybridXmpSpec.cpp +58 -0
  420. package/nitrogen/generated/shared/c++/HybridXmpSpec.hpp +104 -0
  421. package/nitrogen/generated/shared/c++/HybridZipCrcSpec.cpp +43 -0
  422. package/nitrogen/generated/shared/c++/HybridZipCrcSpec.hpp +92 -0
  423. package/nitrogen/generated/shared/c++/HybridZipEntrySpec.cpp +82 -0
  424. package/nitrogen/generated/shared/c++/HybridZipEntrySpec.hpp +137 -0
  425. package/nitrogen/generated/shared/c++/HybridZipSpec.cpp +176 -0
  426. package/nitrogen/generated/shared/c++/HybridZipSpec.hpp +231 -0
  427. package/package.json +46 -0
  428. package/react-native.config.js +9 -0
  429. package/scripts/fetch-chilkat.js +184 -0
  430. package/src/index.ts +306 -0
  431. package/src/runtime/chilkat.ts +25 -0
  432. package/src/specs/Ai.nitro.ts +1288 -0
  433. package/src/specs/Asn.nitro.ts +509 -0
  434. package/src/specs/AuthAws.nitro.ts +234 -0
  435. package/src/specs/AuthAzureSAS.nitro.ts +205 -0
  436. package/src/specs/AuthAzureStorage.nitro.ts +172 -0
  437. package/src/specs/AuthGoogle.nitro.ts +291 -0
  438. package/src/specs/BinData.nitro.ts +470 -0
  439. package/src/specs/Bz2.nitro.ts +269 -0
  440. package/src/specs/Cache.nitro.ts +483 -0
  441. package/src/specs/Cert.nitro.ts +1279 -0
  442. package/src/specs/CertChain.nitro.ts +312 -0
  443. package/src/specs/CertStore.nitro.ts +430 -0
  444. package/src/specs/Charset.nitro.ts +518 -0
  445. package/src/specs/CkDateTime.nitro.ts +492 -0
  446. package/src/specs/CodeSign.nitro.ts +307 -0
  447. package/src/specs/Compression.nitro.ts +654 -0
  448. package/src/specs/Crypt2.nitro.ts +2387 -0
  449. package/src/specs/Csr.nitro.ts +461 -0
  450. package/src/specs/Csv.nitro.ts +670 -0
  451. package/src/specs/Dh.nitro.ts +343 -0
  452. package/src/specs/DirTree.nitro.ts +332 -0
  453. package/src/specs/Dkim.nitro.ts +595 -0
  454. package/src/specs/Dns.nitro.ts +271 -0
  455. package/src/specs/Dsa.nitro.ts +653 -0
  456. package/src/specs/DtObj.nitro.ts +198 -0
  457. package/src/specs/Ecc.nitro.ts +375 -0
  458. package/src/specs/EdDSA.nitro.ts +273 -0
  459. package/src/specs/Email.nitro.ts +2921 -0
  460. package/src/specs/EmailBundle.nitro.ts +334 -0
  461. package/src/specs/FileAccess.nitro.ts +836 -0
  462. package/src/specs/Ftp2.nitro.ts +3943 -0
  463. package/src/specs/Global.nitro.ts +319 -0
  464. package/src/specs/Gzip.nitro.ts +646 -0
  465. package/src/specs/Hashtable.nitro.ts +356 -0
  466. package/src/specs/HtmlToText.nitro.ts +238 -0
  467. package/src/specs/HtmlToXml.nitro.ts +323 -0
  468. package/src/specs/Http.nitro.ts +3095 -0
  469. package/src/specs/HttpCurl.nitro.ts +550 -0
  470. package/src/specs/HttpRequest.nitro.ts +522 -0
  471. package/src/specs/HttpResponse.nitro.ts +424 -0
  472. package/src/specs/Imap.nitro.ts +2991 -0
  473. package/src/specs/JavaKeyStore.nitro.ts +619 -0
  474. package/src/specs/Js.nitro.ts +263 -0
  475. package/src/specs/JsonArray.nitro.ts +681 -0
  476. package/src/specs/JsonObject.nitro.ts +1454 -0
  477. package/src/specs/Jwe.nitro.ts +756 -0
  478. package/src/specs/Jws.nitro.ts +733 -0
  479. package/src/specs/Jwt.nitro.ts +380 -0
  480. package/src/specs/Log.nitro.ts +258 -0
  481. package/src/specs/MailMan.nitro.ts +3571 -0
  482. package/src/specs/Mailboxes.nitro.ts +251 -0
  483. package/src/specs/Mcp.nitro.ts +491 -0
  484. package/src/specs/MessageSet.nitro.ts +320 -0
  485. package/src/specs/Mht.nitro.ts +1684 -0
  486. package/src/specs/Mime.nitro.ts +1745 -0
  487. package/src/specs/Ntlm.nitro.ts +556 -0
  488. package/src/specs/OAuth1.nitro.ts +331 -0
  489. package/src/specs/OAuth2.nitro.ts +1023 -0
  490. package/src/specs/Pdf.nitro.ts +740 -0
  491. package/src/specs/Pem.nitro.ts +484 -0
  492. package/src/specs/Pfx.nitro.ts +1003 -0
  493. package/src/specs/Pkcs11.nitro.ts +559 -0
  494. package/src/specs/PrivateKey.nitro.ts +994 -0
  495. package/src/specs/Prng.nitro.ts +348 -0
  496. package/src/specs/PublicKey.nitro.ts +610 -0
  497. package/src/specs/Rest.nitro.ts +1972 -0
  498. package/src/specs/Rsa.nitro.ts +453 -0
  499. package/src/specs/SCard.nitro.ts +739 -0
  500. package/src/specs/SFtp.nitro.ts +3138 -0
  501. package/src/specs/SFtpDir.nitro.ts +213 -0
  502. package/src/specs/SFtpFile.nitro.ts +452 -0
  503. package/src/specs/ScMinidriver.nitro.ts +443 -0
  504. package/src/specs/Scp.nitro.ts +708 -0
  505. package/src/specs/Secrets.nitro.ts +470 -0
  506. package/src/specs/SecureString.nitro.ts +231 -0
  507. package/src/specs/ServerSentEvent.nitro.ts +183 -0
  508. package/src/specs/Socket.nitro.ts +3335 -0
  509. package/src/specs/Spider.nitro.ts +609 -0
  510. package/src/specs/Ssh.nitro.ts +2842 -0
  511. package/src/specs/SshKey.nitro.ts +740 -0
  512. package/src/specs/SshTunnel.nitro.ts +1243 -0
  513. package/src/specs/Stream.nitro.ts +737 -0
  514. package/src/specs/StringArray.nitro.ts +396 -0
  515. package/src/specs/StringBuilder.nitro.ts +920 -0
  516. package/src/specs/StringTable.nitro.ts +271 -0
  517. package/src/specs/Tar.nitro.ts +804 -0
  518. package/src/specs/TrustedRoots.nitro.ts +360 -0
  519. package/src/specs/UnixCompress.nitro.ts +293 -0
  520. package/src/specs/Upload.nitro.ts +623 -0
  521. package/src/specs/Url.nitro.ts +246 -0
  522. package/src/specs/WebSocket.nitro.ts +840 -0
  523. package/src/specs/Xml.nitro.ts +1988 -0
  524. package/src/specs/XmlCertVault.nitro.ts +259 -0
  525. package/src/specs/XmlDSig.nitro.ts +464 -0
  526. package/src/specs/XmlDSigGen.nitro.ts +978 -0
  527. package/src/specs/Xmp.nitro.ts +364 -0
  528. package/src/specs/Zip.nitro.ts +1611 -0
  529. package/src/specs/ZipCrc.nitro.ts +229 -0
  530. package/src/specs/ZipEntry.nitro.ts +782 -0
@@ -0,0 +1,3138 @@
1
+ // Generated by ReactNativeNs.RnGenerator -- do not edit.
2
+ import type { HybridObject } from 'react-native-nitro-modules'
3
+ import type { BinData } from './BinData.nitro'
4
+ import type { CkDateTime } from './CkDateTime.nitro'
5
+ import type { JsonObject } from './JsonObject.nitro'
6
+ import type { SFtpDir } from './SFtpDir.nitro'
7
+ import type { SecureString } from './SecureString.nitro'
8
+ import type { Ssh } from './Ssh.nitro'
9
+ import type { SshKey } from './SshKey.nitro'
10
+ import type { StringBuilder } from './StringBuilder.nitro'
11
+ import type { StringTable } from './StringTable.nitro'
12
+
13
+ /**
14
+ * Transfer, list, manage, and synchronize files over SFTP.
15
+ *
16
+ * `SFtp` is Chilkat's main class for secure file transfer
17
+ * over SSH. It provides SSH connection and authentication, SFTP subsystem
18
+ * initialization, uploads, downloads, directory listings, remote file
19
+ * management, file attributes, handle-based file access, recursive
20
+ * synchronization, bandwidth throttling, proxy support, host key
21
+ * fingerprinting, SSH algorithm controls, and detailed diagnostics.
22
+ *
23
+ * **SSH + SFTP setup**
24
+ *
25
+ * Connect to an SSH server, authenticate with password or key-based
26
+ * credentials, then initialize the SFTP subsystem before file operations.
27
+ *
28
+ * **Upload and download**
29
+ *
30
+ * Transfer files using simple path-based APIs, in-memory data, streams,
31
+ * or handle-based methods when lower-level control is needed.
32
+ *
33
+ * **Directory and file management**
34
+ *
35
+ * List directories, create and remove folders, rename files, delete files,
36
+ * inspect attributes, and work with remote paths.
37
+ *
38
+ * **Sync-tree operations**
39
+ *
40
+ * Upload or download directory trees and synchronize local and remote
41
+ * folder structures.
42
+ *
43
+ * **Security controls**
44
+ *
45
+ * Verify host keys, control accepted SSH algorithms, use private keys,
46
+ * and configure proxy or network settings when required.
47
+ *
48
+ * **Diagnostics and reliability**
49
+ *
50
+ * Use detailed error text, session logs, progress callbacks, bandwidth
51
+ * limits, and timeout settings to troubleshoot real-world server behavior.
52
+ *
53
+ * **Common pattern:**
54
+ * Connect, authenticate, initialize SFTP, perform file operations using remote
55
+ * paths or handles, close any open handles, and disconnect. Use handle-based
56
+ * APIs for precise control, and synchronization methods for recursive folder
57
+ * transfers.
58
+ *
59
+ * For an extended overview, see
60
+ * [SFtp Class Overview](https://www.chilkatsoft.com/sftp_class_overview.asp).
61
+ *
62
+ * Each `SFtp` instance owns a native Chilkat object. It is released when the JavaScript object is
63
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
64
+ * Create one with `new SFtp()`.
65
+ *
66
+ * Methods that can take a while (network, files, compression, key generation) also have an
67
+ * `...Async` form returning a `Promise`; it runs on a native worker thread so the UI keeps
68
+ * rendering. While such a call is pending, every other call on this object throws, except
69
+ * {@link SFtp.abort} and assigning {@link SFtp.onPercentDone} / {@link SFtp.onProgressInfo}.
70
+ */
71
+ export interface SFtp extends HybridObject<{ ios: 'c++', android: 'c++' }> {
72
+ // ---- Properties ----
73
+
74
+ /**
75
+ * Provides HTML-formatted information about the last called method or property. If a method call
76
+ * fails or behaves unexpectedly, check this property for details. Note that information is
77
+ * available regardless of the method call's success.
78
+ *
79
+ * This property is read-only.
80
+ */
81
+ readonly lastErrorHtml: string
82
+
83
+ /**
84
+ * Provides plain text information about the last called method or property. If a method call
85
+ * fails or behaves unexpectedly, check this property for details. Note that information is
86
+ * available regardless of the method call's success.
87
+ *
88
+ * This property is read-only.
89
+ */
90
+ readonly lastErrorText: string
91
+
92
+ /**
93
+ * Provides XML-formatted information about the last called method or property. If a method call
94
+ * fails or behaves unexpectedly, check this property for details. Note that information is
95
+ * available regardless of the method call's success.
96
+ *
97
+ * This property is read-only.
98
+ */
99
+ readonly lastErrorXml: string
100
+
101
+ /**
102
+ * Version of the component/library, such as "10.1.0"
103
+ *
104
+ * This property is read-only.
105
+ */
106
+ readonly version: string
107
+
108
+ /**
109
+ * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
110
+ * call to the specified file. This logging helps identify the context and history of Chilkat
111
+ * calls leading up to any crash or hang, aiding in debugging.
112
+ *
113
+ * Enabling the VerboseLogging property provides more detailed information.
114
+ *
115
+ * This property is mainly used for debugging rare instances where a Chilkat method call causes a
116
+ * hang or crash, which should generally not happen.
117
+ *
118
+ * Possible causes of hangs include:
119
+ *
120
+ * - A timeout property set to 0, indicating an infinite timeout.
121
+ *
122
+ * - A hang occurring within an event callback in the application code.
123
+ *
124
+ * - An internal bug in the Chilkat code causing the hang.
125
+ */
126
+ debugLogFilePath: string
127
+
128
+ /**
129
+ * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
130
+ * contain more verbose information. The default value is `false`. Verbose logging should only be
131
+ * used for debugging. The potentially large quantity of logged information may adversely affect
132
+ * peformance.
133
+ */
134
+ verboseLogging: boolean
135
+
136
+ /**
137
+ * Indicates the success or failure of the most recent method call: `true` means success, `false`
138
+ * means failure. This property remains unchanged by property setters or getters. This method is
139
+ * present to address challenges in checking for null or Nothing returns in certain programming
140
+ * languages. Note: This property does not apply to methods that return integer values or to
141
+ * boolean-returning methods where the boolean does not indicate success or failure.
142
+ */
143
+ lastMethodSuccess: boolean
144
+
145
+ /**
146
+ * Contains the result code from the most recent call to {@link SFtp.authenticatePw}, {@link
147
+ * SFtp.authenticatePk}, {@link SFtp.authenticatePwPk}, or a corresponding secure-string
148
+ * authentication method.
149
+ *
150
+ * ValueMeaning
151
+ *
152
+ * | `1` | | Transport failure: communication was lost, or a network read or write failed or timed
153
+ * out. |
154
+ *
155
+ * | `2` | | Invalid private key: the key format, key type, or key contents are not suitable for
156
+ * public-key authentication. |
157
+ *
158
+ * | `3` | | No mutually supported authentication method is available. |
159
+ *
160
+ * | `4` | | SSH authentication protocol error: an unexpected or invalid message was received. |
161
+ *
162
+ * | `5` | | The server rejected the supplied password or private key. |
163
+ *
164
+ * | `6` | | The SSH session is already authenticated. |
165
+ *
166
+ * | `7` | | The server requires a password change. See {@link SFtp.passwordChangeRequested}. |
167
+ *
168
+ * Read this property immediately after an authentication method fails. Also inspect
169
+ * `LastErrorText` for detailed diagnostics.
170
+ *
171
+ * **Lifetime:** A later successful authentication does not necessarily reset this value. Consult
172
+ * it only immediately after an authentication method returns `false`; do not use an older value
173
+ * to describe the current session.
174
+ *
175
+ * This property is read-only.
176
+ */
177
+ readonly authFailReason: number
178
+
179
+ /**
180
+ * Specifies the approximate maximum download rate, in bytes per second. The default is `0`, which
181
+ * disables download throttling.
182
+ *
183
+ * Bandwidth throttling is approximate. Actual throughput can vary because of network latency, SSH
184
+ * framing, buffering, and server behavior.
185
+ */
186
+ bandwidthThrottleDown: number
187
+
188
+ /**
189
+ * Specifies the approximate maximum upload rate, in bytes per second. The default is `0`, which
190
+ * disables upload throttling.
191
+ *
192
+ * Bandwidth throttling is approximate. Actual throughput can vary because of network latency, SSH
193
+ * framing, buffering, and server behavior.
194
+ */
195
+ bandwidthThrottleUp: number
196
+
197
+ /**
198
+ * Specifies the SSH client-identification string sent when a connection is established. The
199
+ * default begins with `SSH-2.0-Chilkat_` followed by the Chilkat version, for example
200
+ * `SSH-2.0-Chilkat_11.6.0`.
201
+ *
202
+ * The value should begin with `SSH-2.0-`. A server may disconnect if the identification string is
203
+ * invalid.
204
+ */
205
+ clientIdentifier: string
206
+
207
+ /**
208
+ * **This property is normally left unset.** Set it only on a multihomed computer when the
209
+ * application must bind the outgoing connection to a specific local network interface.
210
+ *
211
+ * Specify a numeric IPv4 or IPv6 address, not a hostname. When the property is empty, the
212
+ * operating system automatically chooses the local address.
213
+ */
214
+ clientIpAddress: string
215
+
216
+ /**
217
+ * Specifies the maximum number of milliseconds allowed for the remote endpoint to accept the TCP
218
+ * connection.
219
+ *
220
+ * This setting covers TCP connection establishment. After the socket is connected, receive and
221
+ * transfer inactivity are governed by {@link SFtp.idleTimeoutMs} and method-specific timeouts.
222
+ */
223
+ connectTimeoutMs: number
224
+
225
+ /**
226
+ * Contains the RFC 4253 reason code from the most recent SSH `DISCONNECT` message received from
227
+ * the server. A value of `0` means no server-provided disconnect code is available.
228
+ *
229
+ * CodeSymbolic name
230
+ *
231
+ * | `1` | | `SSH_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT` |
232
+ *
233
+ * | `2` | | `SSH_DISCONNECT_PROTOCOL_ERROR` |
234
+ *
235
+ * | `3` | | `SSH_DISCONNECT_KEY_EXCHANGE_FAILED` |
236
+ *
237
+ * | `4` | | `SSH_DISCONNECT_RESERVED` |
238
+ *
239
+ * | `5` | | `SSH_DISCONNECT_MAC_ERROR` |
240
+ *
241
+ * | `6` | | `SSH_DISCONNECT_COMPRESSION_ERROR` |
242
+ *
243
+ * | `7` | | `SSH_DISCONNECT_SERVICE_NOT_AVAILABLE` |
244
+ *
245
+ * | `8` | | `SSH_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED` |
246
+ *
247
+ * | `9` | | `SSH_DISCONNECT_HOST_KEY_NOT_VERIFIABLE` |
248
+ *
249
+ * | `10` | | `SSH_DISCONNECT_CONNECTION_LOST` |
250
+ *
251
+ * | `11` | | `SSH_DISCONNECT_BY_APPLICATION` |
252
+ *
253
+ * | `12` | | `SSH_DISCONNECT_TOO_MANY_CONNECTIONS` |
254
+ *
255
+ * | `13` | | `SSH_DISCONNECT_AUTH_CANCELLED_BY_USER` |
256
+ *
257
+ * | `14` | | `SSH_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE` |
258
+ *
259
+ * | `15` | | `SSH_DISCONNECT_ILLEGAL_USER_NAME` |
260
+ *
261
+ * See {@link SFtp.disconnectReason} for the server-provided descriptive text.
262
+ *
263
+ * This property is read-only.
264
+ */
265
+ readonly disconnectCode: number
266
+
267
+ /**
268
+ * Contains the descriptive text sent with the most recent server SSH `DISCONNECT` message. See
269
+ * {@link SFtp.disconnectCode} for the corresponding RFC 4253 reason code.
270
+ *
271
+ * The text is supplied by the server and can be empty or generic. An ordinary TCP loss or a local
272
+ * disconnect does not necessarily produce an SSH disconnect reason.
273
+ *
274
+ * This property is read-only.
275
+ */
276
+ readonly disconnectReason: string
277
+
278
+ /**
279
+ * Controls whether Chilkat caches remote file sizes and attributes requested by {@link
280
+ * SFtp.getFileSize32}, {@link SFtp.getFileSize64}, {@link SFtp.getFileSizeStr}, {@link
281
+ * SFtp.getFileCreateTimeStr}, {@link SFtp.getFileLastAccessStr}, {@link
282
+ * SFtp.getFileLastModifiedStr}, {@link SFtp.getFileOwner}, {@link SFtp.getFileGroup}, {@link
283
+ * SFtp.getFilePermissions}. The default is `false`.
284
+ *
285
+ * When enabled, requesting one attribute by filename causes the complete attribute set for that
286
+ * file to be cached. Later attribute requests for the same filename can be satisfied without
287
+ * another server round trip.
288
+ *
289
+ * Caching applies only when a remote path is used, not when an open handle is used. Call {@link
290
+ * SFtp.clearCache} when remote metadata may have changed.
291
+ */
292
+ enableCache: boolean
293
+
294
+ /**
295
+ * Controls whether SSH compression may be negotiated. The default is `false`.
296
+ *
297
+ * Some older servers advertise compression but fail when it is enabled. If the server disconnects
298
+ * during or immediately after connection or authentication, try leaving this property `false`.
299
+ */
300
+ enableCompression: boolean
301
+
302
+ /**
303
+ * Specifies the character encoding used for SFTP filenames. During {@link SFtp.initializeSftp},
304
+ * Chilkat automatically sets this property when the server supplies a `filename-charset`
305
+ * extension.
306
+ *
307
+ * When the property is empty, incoming and outgoing filenames use UTF-8. Otherwise, Chilkat uses
308
+ * the specified charset, such as `utf-8`, `iso-8859-1`, or `windows-1252`.
309
+ *
310
+ * Use an explicit charset only when required by the server. UTF-8 is the normal SFTP filename
311
+ * encoding.
312
+ */
313
+ filenameCharset: string
314
+
315
+ /**
316
+ * Restricts SSH cipher negotiation to a single cipher. Leave this property empty to use Chilkat's
317
+ * normal preference order. For broader algorithm control, use {@link SFtp.setAllowedAlgorithms}.
318
+ *
319
+ * Cipher nameFamily
320
+ *
321
+ * | `chacha20-poly1305@openssh.com` | | ChaCha20-Poly1305 authenticated encryption |
322
+ *
323
+ * | `aes128-ctr, aes192-ctr, aes256-ctr` | | AES in CTR mode |
324
+ *
325
+ * | `aes128-cbc, aes192-cbc, aes256-cbc` | | AES in CBC mode |
326
+ *
327
+ * | `aes128-gcm@openssh.com, aes256-gcm@openssh.com` | | AES-GCM authenticated encryption |
328
+ *
329
+ * | `twofish128-cbc, twofish256-cbc` | | Twofish in CBC mode |
330
+ *
331
+ * | `blowfish-cbc` | | Blowfish in CBC mode |
332
+ *
333
+ * If the server does not support the selected cipher, {@link SFtp.connect} fails.
334
+ */
335
+ forceCipher: string
336
+
337
+ /**
338
+ * Controls SFTP protocol-version negotiation. The default is `true`, which forces use of SFTP v3
339
+ * even when the server supports a newer version.
340
+ *
341
+ * Set this property to `false` before {@link SFtp.initializeSftp} when the application needs
342
+ * features introduced in SFTP v4, v5, or v6. After initialization, read {@link
343
+ * SFtp.protocolVersion} to determine the negotiated version.
344
+ */
345
+ forceV3: boolean
346
+
347
+ /**
348
+ * Specifies the interval, in milliseconds, between `AbortCheck` event callbacks during operations
349
+ * that support progress events. The default is `0`, which disables periodic callbacks.
350
+ */
351
+ heartbeatMs: number
352
+
353
+ /**
354
+ * Specifies the preferred host-key algorithm used during SSH connection establishment. The
355
+ * default is `DSS`; set it to `RSA` only when required for compatibility with a particular
356
+ * server.
357
+ *
358
+ * Normally this property should be left unchanged.
359
+ */
360
+ hostKeyAlg: string
361
+
362
+ /**
363
+ * Contains the connected server's host-key fingerprint in Chilkat's legacy MD5 format. The value
364
+ * is set after a successful SSH connection.
365
+ *
366
+ * ```
367
+ * ssh-rsa 2048 68:ff:d1:4e:6c:ff:d7:b0:d6:58:73:85:07:bc:2e:d5
368
+ * ssh-ed25519 256 c8:73:22:c7:82:aa:09:f1:1c:4e:99:8a:a0:62:a7:87
369
+ * ```
370
+ *
371
+ * For new applications, use {@link SFtp.getHostKeyFP} with `SHA256`. Compare the fingerprint with
372
+ * a value obtained from a trusted source before sending credentials.
373
+ *
374
+ * The value is cleared by {@link SFtp.disconnect}. Obtain and validate it while the SSH
375
+ * connection is active.
376
+ *
377
+ * This property is read-only.
378
+ */
379
+ readonly hostKeyFingerprint: string
380
+
381
+ /**
382
+ * Specifies the authentication method used by an HTTP proxy. Matching is case-insensitive.
383
+ *
384
+ * ValueBehavior
385
+ *
386
+ * | \*empty\* | | Automatically negotiate a supported method. |
387
+ *
388
+ * | `Basic` | | Use HTTP Basic authentication. |
389
+ *
390
+ * | `NTLM` | | Use NTLM authentication. |
391
+ */
392
+ httpProxyAuthMethod: string
393
+
394
+ /**
395
+ * Specifies the optional Windows domain used for NTLM authentication with an HTTP proxy. This
396
+ * property is ignored for Basic authentication.
397
+ */
398
+ httpProxyDomain: string
399
+
400
+ /**
401
+ * Specifies the hostname or numeric IP address of an HTTP proxy used to establish the SSH
402
+ * connection.
403
+ *
404
+ * Set this property together with {@link SFtp.httpProxyPort}. A configured SOCKS proxy takes
405
+ * precedence when {@link SFtp.socksVersion} is `4` or `5`.
406
+ */
407
+ httpProxyHostname: string
408
+
409
+ /**
410
+ * Specifies the password used to authenticate with an HTTP proxy.
411
+ */
412
+ httpProxyPassword: string
413
+
414
+ /**
415
+ * Specifies the HTTP proxy port. Common values include `8080` and `3128`.
416
+ *
417
+ * The proxy is used when {@link SFtp.httpProxyHostname} is nonempty, this property is nonzero,
418
+ * and {@link SFtp.socksVersion} is `0`.
419
+ */
420
+ httpProxyPort: number
421
+
422
+ /**
423
+ * Specifies the username used to authenticate with an HTTP proxy.
424
+ */
425
+ httpProxyUsername: string
426
+
427
+ /**
428
+ * Specifies the maximum period, in milliseconds, during which an SFTP operation may make no
429
+ * progress while sending or receiving data. The default is `30000` (30 seconds).
430
+ *
431
+ * Set this property to `0` to allow an operation to wait indefinitely.
432
+ */
433
+ idleTimeoutMs: number
434
+
435
+ /**
436
+ * Controls whether `ReadDir` and {@link SFtp.readDirListing} include the special `.` and `..`
437
+ * directory entries. The default is `false`.
438
+ *
439
+ * This property controls only the special directory entries `.` and `..`. It does not exclude
440
+ * ordinary hidden filenames such as `.gitignore` or `.profile`.
441
+ */
442
+ includeDotDirs: boolean
443
+
444
+ /**
445
+ * Contains the RFC 4254 channel-open failure code when {@link SFtp.initializeSftp} cannot open
446
+ * the SFTP session channel. The initial value is `0`.
447
+ *
448
+ * CodeSymbolic name
449
+ *
450
+ * | `1` | | `SSH_OPEN_ADMINISTRATIVELY_PROHIBITED` |
451
+ *
452
+ * | `2` | | `SSH_OPEN_CONNECT_FAILED` |
453
+ *
454
+ * | `3` | | `SSH_OPEN_UNKNOWN_CHANNEL_TYPE` |
455
+ *
456
+ * | `4` | | `SSH_OPEN_RESOURCE_SHORTAGE` |
457
+ *
458
+ * This property is read-only.
459
+ */
460
+ readonly initializeFailCode: number
461
+
462
+ /**
463
+ * Contains the descriptive text associated with {@link SFtp.initializeFailCode} when {@link
464
+ * SFtp.initializeSftp} cannot open the SFTP session channel. The text is supplied by the server
465
+ * and may be empty or generic.
466
+ *
467
+ * This property is read-only.
468
+ */
469
+ readonly initializeFailReason: string
470
+
471
+ /**
472
+ * Returns `true` when Chilkat's last known state indicates that the underlying SSH transport is
473
+ * connected. This means {@link SFtp.connect} succeeded; it does not mean authentication or {@link
474
+ * SFtp.initializeSftp} has completed.
475
+ *
476
+ * This property is passive and does not perform network I/O. A silent network failure or a peer
477
+ * close may remain undetected until an operation reads from or writes to the socket.
478
+ *
479
+ * To actively test whether the connection is still writable, call {@link SFtp.sendIgnore} and
480
+ * check its return value. The server does not reply to an SSH `IGNORE` message.
481
+ *
482
+ * This property is read-only.
483
+ */
484
+ readonly isConnected: boolean
485
+
486
+ /**
487
+ * Controls whether SSH and SFTP protocol traffic is accumulated in {@link SFtp.sessionLog}. The
488
+ * default is `false`.
489
+ *
490
+ * Session logging is intended for diagnostics and grows as activity continues. Disable it when no
491
+ * longer needed and treat the resulting log as potentially sensitive.
492
+ */
493
+ keepSessionLog: boolean
494
+
495
+ /**
496
+ * Specifies the maximum packet length used by the underlying SSH transport. The default is
497
+ * `32768` bytes.
498
+ *
499
+ * Normally this property should remain unchanged.
500
+ */
501
+ maxPacketSize: number
502
+
503
+ /**
504
+ * Indicates that the server rejected password authentication because the account password must be
505
+ * changed. This property is set by {@link SFtp.authenticatePw} and {@link SFtp.authenticatePwPk}.
506
+ *
507
+ * When `true`, call the authentication method again and pass the old and new passwords in this
508
+ * form:
509
+ *
510
+ * ```
511
+ * |oldPassword|newPassword|
512
+ * ```
513
+ *
514
+ * This property is read-only.
515
+ */
516
+ readonly passwordChangeRequested: boolean
517
+
518
+ /**
519
+ * Specifies the value representing 100% completion in `PercentDone` event callbacks. The default
520
+ * is `100`.
521
+ *
522
+ * For example, a scale of `1000` provides 0.1% granularity, so a callback value of `453`
523
+ * represents 45.3% complete. Values are clamped to the range `10` through `100000`.
524
+ *
525
+ * This property applies only in environments that support event callbacks and only to operations
526
+ * for which progress can be measured.
527
+ */
528
+ percentDoneScale: number
529
+
530
+ /**
531
+ * Controls the preferred address family when DNS resolution returns both IPv4 and IPv6 addresses.
532
+ * The default is `false`, which prefers IPv4. Set it to `true` to prefer IPv6.
533
+ */
534
+ preferIpv6: boolean
535
+
536
+ /**
537
+ * Controls whether path-based upload and download methods preserve source timestamps on the
538
+ * destination. The default is `false`.
539
+ *
540
+ * Last-modified time is preserved when supported by the negotiated SFTP version and destination
541
+ * filesystem. SFTP v3 represents these times with whole-second precision and does not provide a
542
+ * creation-time attribute; creation-time preservation requires a later protocol version and
543
+ * server support.
544
+ *
545
+ * This property does not apply to low-level transfers performed by opening a remote handle,
546
+ * reading or writing the data, and then closing the handle.
547
+ */
548
+ preserveDate: boolean
549
+
550
+ /**
551
+ * Contains the SFTP protocol version negotiated by {@link SFtp.initializeSftp}, normally a value
552
+ * from `3` through `6`.
553
+ *
554
+ * Chilkat and the server exchange their highest supported versions, and the session uses the
555
+ * lower compatible version. Features unavailable in older versions are identified throughout this
556
+ * reference documentation.
557
+ *
558
+ * The initial value is `0`. After a successful initialization, the negotiated value can remain
559
+ * populated after {@link SFtp.disconnect} and during a later connection before SFTP is
560
+ * initialized again. Do not use this property alone to determine whether an SFTP channel is
561
+ * currently open.
562
+ *
563
+ * This property is read-only.
564
+ */
565
+ readonly protocolVersion: number
566
+
567
+ /**
568
+ * Specifies a semicolon-separated list of filename patterns. When nonempty, `ReadDir` and {@link
569
+ * SFtp.readDirListing} include only entries matching at least one pattern.
570
+ *
571
+ * - `*` matches zero or more characters.
572
+ *
573
+ * - Matching is case-insensitive.
574
+ *
575
+ * - `?` and bracket expressions such as `[0-9]` are not wildcard operators.
576
+ *
577
+ * - Surrounding whitespace and empty entries between semicolons are ignored.
578
+ *
579
+ * ```
580
+ * *.xml; *.txt; *.csv
581
+ * ```
582
+ */
583
+ readDirMustMatch: string
584
+
585
+ /**
586
+ * Specifies a semicolon-separated list of filename patterns. When nonempty, `ReadDir` and {@link
587
+ * SFtp.readDirListing} exclude entries matching any pattern. Exclusion is applied after {@link
588
+ * SFtp.readDirMustMatch}.
589
+ *
590
+ * - `*` matches zero or more characters.
591
+ *
592
+ * - Matching is case-insensitive.
593
+ *
594
+ * - `?` and bracket expressions such as `[0-9]` are not wildcard operators.
595
+ *
596
+ * - Surrounding whitespace and empty entries between semicolons are ignored.
597
+ *
598
+ * ```
599
+ * *.tmp; *.bak; *.log
600
+ * ```
601
+ */
602
+ readDirMustNotMatch: string
603
+
604
+ /**
605
+ * Contains the in-memory SSH/SFTP protocol log. Enable logging by setting {@link
606
+ * SFtp.keepSessionLog} to `true`.
607
+ *
608
+ * This property contains log text, not a file path. Call {@link SFtp.clearSessionLog} to clear
609
+ * it.
610
+ *
611
+ * This property is read-only.
612
+ */
613
+ readonly sessionLog: string
614
+
615
+ /**
616
+ * Specifies the socket receive-buffer size. The default is `4194304` bytes. Normally this
617
+ * property should remain unchanged.
618
+ *
619
+ * When download throughput is unexpectedly low, testing a larger value may help. Values should
620
+ * generally be multiples of `4096`.
621
+ */
622
+ soRcvBuf: number
623
+
624
+ /**
625
+ * Specifies the socket send-buffer size. The default is `262144` bytes. Normally this property
626
+ * should remain unchanged.
627
+ *
628
+ * When upload throughput is unexpectedly low, testing values such as `524288` or `1048576` may
629
+ * help. Values should generally be multiples of `4096`.
630
+ */
631
+ soSndBuf: number
632
+
633
+ /**
634
+ * Specifies the SOCKS proxy hostname or IPv4 address. This property is used only when {@link
635
+ * SFtp.socksVersion} is `4` or `5`.
636
+ */
637
+ socksHostname: string
638
+
639
+ /**
640
+ * Specifies the SOCKS5 password when username/password authentication is required. SOCKS4 does
641
+ * not use a password, so this property is ignored when {@link SFtp.socksVersion} is `4`.
642
+ */
643
+ socksPassword: string
644
+
645
+ /**
646
+ * Specifies the SOCKS proxy port. The default is `1080`. This property is used only when {@link
647
+ * SFtp.socksVersion} is `4` or `5`.
648
+ */
649
+ socksPort: number
650
+
651
+ /**
652
+ * Specifies the SOCKS proxy username. For SOCKS4 it is sent as the user ID; for SOCKS5 it is used
653
+ * with {@link SFtp.socksPassword} for username/password authentication.
654
+ */
655
+ socksUsername: string
656
+
657
+ /**
658
+ * Selects whether and how a SOCKS proxy is used.
659
+ *
660
+ * ValueBehavior
661
+ *
662
+ * | `0` | | Do not use a SOCKS proxy. This is the default. |
663
+ *
664
+ * | `4` | | Connect through a SOCKS4 proxy. |
665
+ *
666
+ * | `5` | | Connect through a SOCKS5 proxy. |
667
+ */
668
+ socksVersion: number
669
+
670
+ /**
671
+ * Specifies a semicolon-separated list of wildcard filename patterns. {@link SFtp.syncTreeUpload}
672
+ * and {@link SFtp.syncTreeDownload} transfer only files matching at least one pattern.
673
+ *
674
+ * This filter applies to filenames, not directory names encountered while recursively traversing
675
+ * a tree.
676
+ *
677
+ * ```
678
+ * *.xml;*.txt;*.csv
679
+ * ```
680
+ *
681
+ * Use `*` to match zero or more characters. Separate multiple patterns with semicolons.
682
+ */
683
+ syncMustMatch: string
684
+
685
+ /**
686
+ * Specifies a semicolon-separated list of wildcard filename patterns. {@link SFtp.syncTreeUpload}
687
+ * and {@link SFtp.syncTreeDownload} skip files matching any pattern.
688
+ *
689
+ * This filter applies to filenames, not directory names encountered while recursively traversing
690
+ * a tree.
691
+ *
692
+ * ```
693
+ * *.tmp;*.bak;*.log
694
+ * ```
695
+ *
696
+ * Use `*` to match zero or more characters. Separate multiple patterns with semicolons.
697
+ */
698
+ syncMustNotMatch: string
699
+
700
+ /**
701
+ * Controls the `TCP_NODELAY` socket option. The default is `false`. Set it to `true` to disable
702
+ * the Nagle algorithm and reduce delays when many small packets are sent.
703
+ */
704
+ tcpNoDelay: boolean
705
+
706
+ /**
707
+ * Specifies the chunk size, in bytes, used by {@link SFtp.uploadFile} and {@link
708
+ * SFtp.uploadFileByName}. The default is `32000`.
709
+ *
710
+ * If an upload fails because the local operating system aborts the connection, try a smaller
711
+ * value such as `4096`. Smaller chunks can reduce throughput.
712
+ */
713
+ uploadChunkSize: number
714
+
715
+ /**
716
+ * Controls the time zone used by date/time getters. When `true`, returned values are expressed in
717
+ * UTC. When `false` (the default), returned values are converted to the local time zone.
718
+ *
719
+ * ```
720
+ * UtcMode = _FALSE_: Fri, 21 Nov 1997 09:55:06 -0600
721
+ * UtcMode = _TRUE_: Fri, 21 Nov 1997 15:55:06 GMT
722
+ * ```
723
+ */
724
+ utcMode: boolean
725
+
726
+ /**
727
+ * Set to `true` to request that the currently running Chilkat operation abort. Both synchronous
728
+ * and asynchronous operations can be canceled; a synchronous call may be interrupted by setting
729
+ * this property from another thread.
730
+ *
731
+ * When the abort is observed, the current method returns failure and Chilkat resets this property
732
+ * to `false`. If no method is running, it is reset when the next method begins.
733
+ */
734
+ abortCurrent: boolean
735
+
736
+ /**
737
+ * Specifies comma-separated directives that modify {@link SFtp.syncTreeUpload} or {@link
738
+ * SFtp.syncTreeDownload}. The default is an empty string.
739
+ *
740
+ * DirectiveEffect
741
+ *
742
+ * | `UploadIgnoreLocalOpenFailures` | | During upload synchronization, skip local files that
743
+ * cannot be opened, such as files held with exclusive access by another process. |
744
+ */
745
+ syncDirectives: string
746
+
747
+ /**
748
+ * Contains the current transfer byte count for an upload or download in progress. An application
749
+ * can read this property while an asynchronous transfer is running.
750
+ *
751
+ * For {@link SFtp.syncTreeUpload} and {@link SFtp.syncTreeDownload}, the value is cumulative
752
+ * across all files processed by the operation. Use {@link SFtp.xferByteCount64} when a 64-bit
753
+ * count is required.
754
+ *
755
+ * This property is read-only.
756
+ */
757
+ readonly xferByteCount: number
758
+
759
+ /**
760
+ * Contains the current 64-bit transfer byte count for an upload or download in progress. An
761
+ * application can read this property while an asynchronous transfer is running.
762
+ *
763
+ * For {@link SFtp.syncTreeUpload} and {@link SFtp.syncTreeDownload}, the value is cumulative
764
+ * across all files processed by the operation.
765
+ *
766
+ * This property is read-only.
767
+ *
768
+ * A 64-bit integer in Chilkat; JavaScript numbers are exact up to 2^53.
769
+ */
770
+ readonly xferByteCount64: number
771
+
772
+ /**
773
+ * Contains the SSH server-identification string received during connection establishment. For
774
+ * example:
775
+ *
776
+ * ```
777
+ * SSH-2.0-OpenSSH_8.9p1 Ubuntu-3ubuntu0.16
778
+ * ```
779
+ *
780
+ * The last received identifier can remain populated after {@link SFtp.disconnect}. Use {@link
781
+ * SFtp.isConnected} to determine whether the SSH transport is currently connected.
782
+ *
783
+ * This property is read-only.
784
+ */
785
+ readonly serverIdentifier: string
786
+
787
+ /**
788
+ * Provides comma-separated compatibility, security, and synchronization options for uncommon
789
+ * scenarios. The default is an empty string and is appropriate for most applications.
790
+ *
791
+ * KeywordEffect
792
+ *
793
+ * | `ForceUserAuthRsaSha1` | | Force legacy `ssh-rsa`/SHA-1 signatures for RSA user
794
+ * authentication. Set before connecting. |
795
+ *
796
+ * | `ProtectFromVpn` | | On Android, bypass an installed or active VPN. |
797
+ *
798
+ * | `NoSyncDownloadEmptyFiles` | | Prevent empty files from being downloaded by
799
+ * `SyncTreeDownload`. |
800
+ *
801
+ * | `no-weak-mac-algs` | | Remove weaker SHA-1, MD5, and RIPEMD-160 MAC algorithms from the
802
+ * offered list. |
803
+ *
804
+ * | `+ssh-hmac-etm` | | Re-enable OpenSSH Encrypt-then-MAC algorithms disabled by default as a
805
+ * Terrapin mitigation. |
806
+ *
807
+ * | `+chacha20-poly1305@openssh.com` | | Re-enable `chacha20-poly1305@openssh.com`, disabled by
808
+ * default as a Terrapin mitigation. |
809
+ */
810
+ uncommonOptions: string
811
+
812
+ /**
813
+ * Specifies a semicolon-separated list of wildcard directory-name patterns. {@link
814
+ * SFtp.syncTreeUpload} and {@link SFtp.syncTreeDownload} enter only directories matching at least
815
+ * one pattern.
816
+ *
817
+ * ```
818
+ * xml;txt;data_*
819
+ * ```
820
+ *
821
+ * Use `*` to match zero or more characters. Separate multiple patterns with semicolons.
822
+ */
823
+ syncMustMatchDir: string
824
+
825
+ /**
826
+ * Specifies a semicolon-separated list of wildcard directory-name patterns. {@link
827
+ * SFtp.syncTreeUpload} and {@link SFtp.syncTreeDownload} skip directories matching any pattern.
828
+ *
829
+ * ```
830
+ * temp;cache;archive_*
831
+ * ```
832
+ *
833
+ * Use `*` to match zero or more characters. Separate multiple patterns with semicolons.
834
+ */
835
+ syncMustNotMatchDir: string
836
+
837
+ /**
838
+ * Controls whether {@link SFtp.syncTreeDownload} creates empty remote directories locally. The
839
+ * default is `true`.
840
+ *
841
+ * When `false`, a local directory is created only when it is needed to contain a downloaded file.
842
+ *
843
+ * When `true`, an empty remote directory is created locally even when no file beneath it is
844
+ * downloaded.
845
+ */
846
+ syncCreateAllLocalDirs: boolean
847
+
848
+ /**
849
+ * Contains the numeric code from the most recently received SFTP `SSH_FXP_STATUS` response. This
850
+ * is not necessarily the status of the most recently called method. Methods that return a handle,
851
+ * attributes, or data can complete without receiving a new status response, leaving an older
852
+ * value unchanged. A successful method can therefore leave a previous nonzero status code in this
853
+ * property.
854
+ *
855
+ * CodeSymbolic name
856
+ *
857
+ * | `0` | | `SSH_FX_OK` |
858
+ *
859
+ * | `1` | | `SSH_FX_EOF` |
860
+ *
861
+ * | `2` | | `SSH_FX_NO_SUCH_FILE` |
862
+ *
863
+ * | `3` | | `SSH_FX_PERMISSION_DENIED` |
864
+ *
865
+ * | `4` | | `SSH_FX_FAILURE` |
866
+ *
867
+ * | `5` | | `SSH_FX_BAD_MESSAGE` |
868
+ *
869
+ * | `6` | | `SSH_FX_NO_CONNECTION` |
870
+ *
871
+ * | `7` | | `SSH_FX_CONNECTION_LOST` |
872
+ *
873
+ * | `8` | | `SSH_FX_OP_UNSUPPORTED` |
874
+ *
875
+ * | `9` | | `SSH_FX_INVALID_HANDLE` |
876
+ *
877
+ * | `10` | | `SSH_FX_NO_SUCH_PATH` |
878
+ *
879
+ * | `11` | | `SSH_FX_FILE_ALREADY_EXISTS` |
880
+ *
881
+ * | `12` | | `SSH_FX_WRITE_PROTECT` |
882
+ *
883
+ * | `13` | | `SSH_FX_NO_MEDIA` |
884
+ *
885
+ * | `14` | | `SSH_FX_NO_SPACE_ON_FILESYSTEM` |
886
+ *
887
+ * | `15` | | `SSH_FX_QUOTA_EXCEEDED` |
888
+ *
889
+ * | `16` | | `SSH_FX_UNKNOWN_PRINCIPAL` |
890
+ *
891
+ * | `17` | | `SSH_FX_LOCK_CONFLICT` |
892
+ *
893
+ * | `18` | | `SSH_FX_DIR_NOT_EMPTY` |
894
+ *
895
+ * | `19` | | `SSH_FX_NOT_A_DIRECTORY` |
896
+ *
897
+ * | `20` | | `SSH_FX_INVALID_FILENAME` |
898
+ *
899
+ * | `21` | | `SSH_FX_LINK_LOOP` |
900
+ *
901
+ * | `22` | | `SSH_FX_CANNOT_DELETE` |
902
+ *
903
+ * | `23` | | `SSH_FX_INVALID_PARAMETER` |
904
+ *
905
+ * | `24` | | `SSH_FX_FILE_IS_A_DIRECTORY` |
906
+ *
907
+ * | `25` | | `SSH_FX_BYTE_RANGE_LOCK_CONFLICT` |
908
+ *
909
+ * | `26` | | `SSH_FX_BYTE_RANGE_LOCK_REFUSED` |
910
+ *
911
+ * | `27` | | `SSH_FX_DELETE_PENDING` |
912
+ *
913
+ * | `28` | | `SSH_FX_FILE_CORRUPT` |
914
+ *
915
+ * | `29` | | `SSH_FX_OWNER_INVALID` |
916
+ *
917
+ * | `30` | | `SSH_FX_GROUP_INVALID` |
918
+ *
919
+ * | `31` | | `SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK` |
920
+ *
921
+ * See {@link SFtp.lastStatusMessage} for the server-provided message text.
922
+ *
923
+ * Use each method's documented return value as the primary success test. Read this property
924
+ * immediately after a relevant SFTP failure when the server status provides additional detail.
925
+ *
926
+ * This property is read-only.
927
+ */
928
+ readonly lastStatusCode: number
929
+
930
+ /**
931
+ * Contains the message text from the most recently received SFTP `SSH_FXP_STATUS` response. The
932
+ * wording is server-dependent.
933
+ *
934
+ * This property can remain unchanged across later successful methods that do not receive a new
935
+ * status response. See {@link SFtp.lastStatusCode} for the numeric code.
936
+ *
937
+ * This property is read-only.
938
+ */
939
+ readonly lastStatusMessage: string
940
+
941
+ /**
942
+ * Contains a user-authentication banner received from the server. Check this property after
943
+ * {@link SFtp.startKeyboardAuth} or another authentication attempt and display it to the user
944
+ * when appropriate.
945
+ *
946
+ * When no banner is available, the property returns an empty string.
947
+ */
948
+ userAuthBanner: string
949
+
950
+ /**
951
+ * Enables automatic resolution of secret specification strings from secure operating-system
952
+ * storage. The default is `false`.
953
+ *
954
+ * When `true`, supported password properties and authentication methods may receive a value
955
+ * beginning with `!!` instead of a literal credential. Chilkat resolves the secret from Windows
956
+ * Credential Manager on Windows or Apple Keychain on macOS.
957
+ *
958
+ * Secret specification format:
959
+ *
960
+ * ```
961
+ * !![appName|]service[|domain]|username
962
+ * ```
963
+ *
964
+ * This feature applies to {@link SFtp.httpProxyPassword}, {@link SFtp.socksPassword}, {@link
965
+ * SFtp.authenticatePw}, and {@link SFtp.authenticatePwPk}.
966
+ */
967
+ enableSecrets: boolean
968
+
969
+ // ---- Methods ----
970
+
971
+ /**
972
+ * Authenticates the connected SSH session using public-key authentication. `username` identifies
973
+ * the server account, and `privateKey` must contain the corresponding private key. The matching
974
+ * public key must already be authorized for that account on the server.
975
+ *
976
+ * Call {@link SFtp.connect} first. After a failure, inspect {@link SFtp.authFailReason} and
977
+ * `LastErrorText`.
978
+ *
979
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
980
+ * {@link SFtp.authenticatePkAsync}.
981
+ *
982
+ * @throws Error if the call fails (the message names the reason); the full log is in
983
+ * {@link SFtp.lastErrorText}.
984
+ */
985
+ authenticatePk(username: string, privateKey: SshKey): void
986
+
987
+ /**
988
+ * Asynchronous form of {@link SFtp.authenticatePk}: the same call on a native worker thread,
989
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
990
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
991
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
992
+ *
993
+ * The promise rejects with an Error if the call fails; the full log is in
994
+ * {@link SFtp.lastErrorText}.
995
+ */
996
+ authenticatePkAsync(username: string, privateKey: SshKey): Promise<void>
997
+
998
+ /**
999
+ * Authenticates the connected SSH session using `login` and `password`.
1000
+ *
1001
+ * ```
1002
+ * 1. Connect
1003
+ * 2. AuthenticatePw or AuthenticatePk
1004
+ * 3. InitializeSftp
1005
+ * ```
1006
+ *
1007
+ * If the server requests a password change, see {@link SFtp.passwordChangeRequested}. After a
1008
+ * failure, inspect {@link SFtp.authFailReason} and `LastErrorText`.
1009
+ *
1010
+ * A rejected password does not necessarily close the SSH connection. The application may retry
1011
+ * authentication on the same connected session. After a later success, an older {@link
1012
+ * SFtp.authFailReason} value can remain populated.
1013
+ *
1014
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1015
+ * {@link SFtp.authenticatePwAsync}.
1016
+ *
1017
+ * @throws Error if the call fails (the message names the reason); the full log is in
1018
+ * {@link SFtp.lastErrorText}.
1019
+ */
1020
+ authenticatePw(login: string, password: string): void
1021
+
1022
+ /**
1023
+ * Asynchronous form of {@link SFtp.authenticatePw}: the same call on a native worker thread,
1024
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1025
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1026
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1027
+ *
1028
+ * The promise rejects with an Error if the call fails; the full log is in
1029
+ * {@link SFtp.lastErrorText}.
1030
+ */
1031
+ authenticatePwAsync(login: string, password: string): Promise<void>
1032
+
1033
+ /**
1034
+ * Authenticates with a server that requires both a password and a private key. `username`
1035
+ * identifies the account, `password` supplies the password, and `privateKey` supplies the private
1036
+ * key.
1037
+ *
1038
+ * Most servers require either password or public-key authentication rather than both. After a
1039
+ * failure, inspect {@link SFtp.authFailReason} and `LastErrorText`.
1040
+ *
1041
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1042
+ * {@link SFtp.authenticatePwPkAsync}.
1043
+ *
1044
+ * @throws Error if the call fails (the message names the reason); the full log is in
1045
+ * {@link SFtp.lastErrorText}.
1046
+ */
1047
+ authenticatePwPk(username: string, password: string, privateKey: SshKey): void
1048
+
1049
+ /**
1050
+ * Asynchronous form of {@link SFtp.authenticatePwPk}: the same call on a native worker thread,
1051
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1052
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1053
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1054
+ *
1055
+ * The promise rejects with an Error if the call fails; the full log is in
1056
+ * {@link SFtp.lastErrorText}.
1057
+ */
1058
+ authenticatePwPkAsync(username: string, password: string, privateKey: SshKey): Promise<void>
1059
+
1060
+ /**
1061
+ * Clears the internal remote file-attribute cache used when {@link SFtp.enableCache} is `true`.
1062
+ */
1063
+ clearCache(): void
1064
+
1065
+ /**
1066
+ * Clears the in-memory text stored in {@link SFtp.sessionLog}.
1067
+ */
1068
+ clearSessionLog(): void
1069
+
1070
+ /**
1071
+ * Closes the remote file or directory handle specified by `handle`. The handle must have been
1072
+ * returned by {@link SFtp.openFile} or {@link SFtp.openDir}.
1073
+ *
1074
+ * Handles are specific to one initialized SFTP session. Close each handle exactly once. Closing
1075
+ * an empty, invalid, or already-closed handle returns `false`. A handle must never be reused
1076
+ * after disconnecting or replacing the connection.
1077
+ *
1078
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1079
+ * {@link SFtp.closeHandleAsync}.
1080
+ *
1081
+ * @throws Error if the call fails (the message names the reason); the full log is in
1082
+ * {@link SFtp.lastErrorText}.
1083
+ */
1084
+ closeHandle(handle: string): void
1085
+
1086
+ /**
1087
+ * Asynchronous form of {@link SFtp.closeHandle}: the same call on a native worker thread,
1088
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1089
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1090
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1091
+ *
1092
+ * The promise rejects with an Error if the call fails; the full log is in
1093
+ * {@link SFtp.lastErrorText}.
1094
+ */
1095
+ closeHandleAsync(handle: string): Promise<void>
1096
+
1097
+ /**
1098
+ * Establishes an SSH connection to `domainName` on TCP port `port`. The host may be a DNS name or
1099
+ * numeric IPv4 or IPv6 address; SSH servers commonly listen on port `22`.
1100
+ *
1101
+ * A successful connection establishes the SSH transport only. Next call an authentication method,
1102
+ * then call {@link SFtp.initializeSftp}.
1103
+ *
1104
+ * ```
1105
+ * 1. Connect
1106
+ * 2. AuthenticatePw, AuthenticatePk, or another authentication method
1107
+ * 3. InitializeSftp
1108
+ * 4. Perform SFTP operations
1109
+ * ```
1110
+ *
1111
+ * **Supported negotiation algorithms include:**
1112
+ *
1113
+ * CategoryAlgorithms
1114
+ *
1115
+ * | Host key | | `ssh-ed25519`, `rsa-sha2-256`, `rsa-sha2-512`, `ecdsa-sha2-nistp256`,
1116
+ * `ecdsa-sha2-nistp384`, `ecdsa-sha2-nistp521`, `ssh-rsa`, `ssh-dss` |
1117
+ *
1118
+ * | Key exchange | | `curve25519-sha256`, `curve25519-sha256@libssh.org`, NIST ECDH,
1119
+ * Diffie-Hellman group 1/14/16/18, and group-exchange SHA-1/SHA-256 |
1120
+ *
1121
+ * | Ciphers | | AES CTR/CBC/GCM, Twofish CBC, Blowfish CBC, and optionally
1122
+ * `chacha20-poly1305@openssh.com` |
1123
+ *
1124
+ * | MAC | | SHA-2, SHA-1, RIPEMD-160, MD5, and optionally OpenSSH Encrypt-then-MAC variants |
1125
+ *
1126
+ * | Compression | | `none`, `zlib`, and `zlib@openssh.com` |
1127
+ *
1128
+ * Connection failures can occur before SSH negotiation because of firewalls, endpoint security,
1129
+ * routing, network ACLs, proxy configuration, or server policy.
1130
+ *
1131
+ * **Calling while connected:** A new successful `Connect` replaces the existing SSH connection.
1132
+ * The previous SFTP subsystem and all handles from it are no longer usable. Authenticate and call
1133
+ * {@link SFtp.initializeSftp} for the new connection.
1134
+ *
1135
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1136
+ * {@link SFtp.connectAsync}.
1137
+ *
1138
+ * @throws Error if the call fails (the message names the reason); the full log is in
1139
+ * {@link SFtp.lastErrorText}.
1140
+ */
1141
+ connect(domainName: string, port: number): void
1142
+
1143
+ /**
1144
+ * Asynchronous form of {@link SFtp.connect}: the same call on a native worker thread,
1145
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1146
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1147
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1148
+ *
1149
+ * The promise rejects with an Error if the call fails; the full log is in
1150
+ * {@link SFtp.lastErrorText}.
1151
+ */
1152
+ connectAsync(domainName: string, port: number): Promise<void>
1153
+
1154
+ /**
1155
+ * Connects to `hostname` on `port` through the already connected and authenticated `Ssh` object
1156
+ * in `sshConn`.
1157
+ *
1158
+ * ```
1159
+ * application → first SSH server → destination SSH/SFTP server
1160
+ * ```
1161
+ *
1162
+ * After this method succeeds, authenticate separately with the destination server and call
1163
+ * `InitializeSftp`. All destination traffic is carried through the first SSH connection.
1164
+ *
1165
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1166
+ * {@link SFtp.connectThroughSshAsync}.
1167
+ *
1168
+ * @throws Error if the call fails (the message names the reason); the full log is in
1169
+ * {@link SFtp.lastErrorText}.
1170
+ */
1171
+ connectThroughSsh(sshConn: Ssh, hostname: string, port: number): void
1172
+
1173
+ /**
1174
+ * Asynchronous form of {@link SFtp.connectThroughSsh}: the same call on a native worker thread,
1175
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1176
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1177
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1178
+ *
1179
+ * The promise rejects with an Error if the call fails; the full log is in
1180
+ * {@link SFtp.lastErrorText}.
1181
+ */
1182
+ connectThroughSshAsync(sshConn: Ssh, hostname: string, port: number): Promise<void>
1183
+
1184
+ /**
1185
+ * Copies supported timestamps and attributes from the local file at `localFilename` to the remote
1186
+ * item identified by `remoteFilename`.
1187
+ *
1188
+ * Set `isHandle` to `true` when `remoteFilename` contains an open SFTP handle; otherwise set it
1189
+ * to `false` for a remote path.
1190
+ *
1191
+ * Negotiated SFTP versionAttributes copied
1192
+ *
1193
+ * | SFTP v3 and earlier | | Last-modified time and last-access time |
1194
+ *
1195
+ * | SFTP v4 and v5 | | Last-modified time, last-access time, and creation time |
1196
+ *
1197
+ * | SFTP v6 and later | | The preceding timestamps plus read-only, hidden, archive, compressed,
1198
+ * and encrypted flags |
1199
+ *
1200
+ * The remote server and filesystem determine whether all requested attributes can be applied.
1201
+ * Last-access time may change when the server accesses the file, and compressed or encrypted
1202
+ * flags may not have the same effect on every server.
1203
+ *
1204
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1205
+ * {@link SFtp.copyFileAttrAsync}.
1206
+ *
1207
+ * @throws Error if the call fails (the message names the reason); the full log is in
1208
+ * {@link SFtp.lastErrorText}.
1209
+ */
1210
+ copyFileAttr(localFilename: string, remoteFilename: string, isHandle: boolean): void
1211
+
1212
+ /**
1213
+ * Asynchronous form of {@link SFtp.copyFileAttr}: the same call on a native worker thread,
1214
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1215
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1216
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1217
+ *
1218
+ * The promise rejects with an Error if the call fails; the full log is in
1219
+ * {@link SFtp.lastErrorText}.
1220
+ */
1221
+ copyFileAttrAsync(localFilename: string, remoteFilename: string, isHandle: boolean): Promise<void>
1222
+
1223
+ /**
1224
+ * Creates the remote directory specified by `path`. Parent directories are not necessarily
1225
+ * created automatically.
1226
+ *
1227
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1228
+ * {@link SFtp.createDirAsync}.
1229
+ *
1230
+ * @throws Error if the call fails (the message names the reason); the full log is in
1231
+ * {@link SFtp.lastErrorText}.
1232
+ */
1233
+ createDir(path: string): void
1234
+
1235
+ /**
1236
+ * Asynchronous form of {@link SFtp.createDir}: the same call on a native worker thread,
1237
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1238
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1239
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1240
+ *
1241
+ * The promise rejects with an Error if the call fails; the full log is in
1242
+ * {@link SFtp.lastErrorText}.
1243
+ */
1244
+ createDirAsync(path: string): Promise<void>
1245
+
1246
+ /**
1247
+ * Closes the current SSH/SFTP connection. All remote file and directory handles from that session
1248
+ * become invalid and must not be reused.
1249
+ *
1250
+ * The object remains reusable. A later session must call {@link SFtp.connect}, authenticate
1251
+ * again, and call {@link SFtp.initializeSftp} before performing SFTP operations.
1252
+ *
1253
+ * Some properties retain values from the previous session after disconnect, including the
1254
+ * negotiated protocol version, server identifier, and last SFTP status. Treat these as historical
1255
+ * values rather than evidence of a live session.
1256
+ */
1257
+ disconnect(): void
1258
+
1259
+ /**
1260
+ * Streams the remote file identified by `handle` to the local filesystem path `toFilename`. The
1261
+ * handle must have been returned by {@link SFtp.openFile}.
1262
+ *
1263
+ * The transfer is streamed and is not limited by available memory. Close the remote handle when
1264
+ * the download is complete.
1265
+ *
1266
+ * This method downloads the entire remote file beginning at byte offset `0`. It does not begin at
1267
+ * the handle's current sequential read position.
1268
+ *
1269
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1270
+ * {@link SFtp.downloadFileAsync}.
1271
+ *
1272
+ * @throws Error if the call fails (the message names the reason); the full log is in
1273
+ * {@link SFtp.lastErrorText}.
1274
+ */
1275
+ downloadFile(handle: string, toFilename: string): void
1276
+
1277
+ /**
1278
+ * Asynchronous form of {@link SFtp.downloadFile}: the same call on a native worker thread,
1279
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1280
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1281
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1282
+ *
1283
+ * The promise rejects with an Error if the call fails; the full log is in
1284
+ * {@link SFtp.lastErrorText}.
1285
+ */
1286
+ downloadFileAsync(handle: string, toFilename: string): Promise<void>
1287
+
1288
+ /**
1289
+ * Downloads the remote file at `remoteFilePath` to the local filesystem path `localFilePath`.
1290
+ *
1291
+ * When {@link SFtp.preserveDate} is `true`, Chilkat preserves the remote file's last-modified
1292
+ * time.
1293
+ *
1294
+ * An absolute remote path begins with `/` and is relative to the server filesystem root. A
1295
+ * relative path is interpreted relative to the authenticated user's home directory.
1296
+ *
1297
+ * If the local destination file exists, it is truncated before the download.
1298
+ *
1299
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1300
+ * {@link SFtp.downloadFileByNameAsync}.
1301
+ *
1302
+ * @throws Error if the call fails (the message names the reason); the full log is in
1303
+ * {@link SFtp.lastErrorText}.
1304
+ */
1305
+ downloadFileByName(remoteFilePath: string, localFilePath: string): void
1306
+
1307
+ /**
1308
+ * Asynchronous form of {@link SFtp.downloadFileByName}: the same call on a native worker thread,
1309
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1310
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1311
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1312
+ *
1313
+ * The promise rejects with an Error if the call fails; the full log is in
1314
+ * {@link SFtp.lastErrorText}.
1315
+ */
1316
+ downloadFileByNameAsync(remoteFilePath: string, localFilePath: string): Promise<void>
1317
+
1318
+ /**
1319
+ * Returns `true` when the most recent read for `handle` received the SFTP end-of-file status.
1320
+ *
1321
+ * Reading exactly through the final byte does not set EOF immediately. The next read returns
1322
+ * successfully with zero bytes, sets {@link SFtp.lastStatusCode} to `SSH_FX_EOF`, and causes this
1323
+ * method to return `true`.
1324
+ *
1325
+ * An empty, malformed, or already-closed handle can also cause this method to return `true`. Use
1326
+ * {@link SFtp.lastReadFailed} and the read method's result to distinguish a normal EOF from a
1327
+ * handle or read failure.
1328
+ */
1329
+ eof(handle: string): boolean
1330
+
1331
+ /**
1332
+ * Returns the remote file's creation date and time. `pathOrHandle` may contain a remote path or a
1333
+ * handle returned by {@link SFtp.openFile}. Set `bIsHandle` to `true` for a handle and `false`
1334
+ * for a path.
1335
+ *
1336
+ * When `bFollowLinks` is `true`, the server follows a symbolic link and returns metadata for its
1337
+ * target.
1338
+ *
1339
+ * SFTP v3 and earlier do not provide a file creation time.
1340
+ *
1341
+ * The result is an RFC 822 formatted string, for example `Fri, 21 Nov 1997 09:55:06 -0600`.
1342
+ *
1343
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1344
+ * {@link SFtp.getFileCreateTimeStrAsync}.
1345
+ *
1346
+ * @throws Error if the call fails (the message names the reason); the full log is in
1347
+ * {@link SFtp.lastErrorText}.
1348
+ */
1349
+ getFileCreateTimeStr(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): string
1350
+
1351
+ /**
1352
+ * Asynchronous form of {@link SFtp.getFileCreateTimeStr}: the same call on a native worker
1353
+ * thread,
1354
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1355
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1356
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1357
+ *
1358
+ * The promise rejects with an Error if the call fails; the full log is in
1359
+ * {@link SFtp.lastErrorText}.
1360
+ */
1361
+ getFileCreateTimeStrAsync(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): Promise<string>
1362
+
1363
+ /**
1364
+ * Returns the remote file's group ownership. `pathOrHandle` may contain a remote path or a handle
1365
+ * returned by {@link SFtp.openFile}. Set `bIsHandle` to `true` for a handle and `false` for a
1366
+ * path.
1367
+ *
1368
+ * When `bFollowLinks` is `true`, the server follows a symbolic link and returns metadata for its
1369
+ * target.
1370
+ *
1371
+ * With SFTP v3 and earlier, the result is the decimal numeric GID because textual group names are
1372
+ * not supported.
1373
+ *
1374
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1375
+ * {@link SFtp.getFileGroupAsync}.
1376
+ *
1377
+ * @throws Error if the call fails (the message names the reason); the full log is in
1378
+ * {@link SFtp.lastErrorText}.
1379
+ */
1380
+ getFileGroup(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): string
1381
+
1382
+ /**
1383
+ * Asynchronous form of {@link SFtp.getFileGroup}: the same call on a native worker thread,
1384
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1385
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1386
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1387
+ *
1388
+ * The promise rejects with an Error if the call fails; the full log is in
1389
+ * {@link SFtp.lastErrorText}.
1390
+ */
1391
+ getFileGroupAsync(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): Promise<string>
1392
+
1393
+ /**
1394
+ * Returns the remote file's last-access date and time. `pathOrHandle` may contain a remote path
1395
+ * or a handle returned by {@link SFtp.openFile}. Set `bIsHandle` to `true` for a handle and
1396
+ * `false` for a path.
1397
+ *
1398
+ * When `bFollowLinks` is `true`, the server follows a symbolic link and returns metadata for its
1399
+ * target.
1400
+ *
1401
+ * The result is an RFC 822 formatted string, for example `Fri, 21 Nov 1997 09:55:06 -0600`.
1402
+ *
1403
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1404
+ * {@link SFtp.getFileLastAccessStrAsync}.
1405
+ *
1406
+ * @throws Error if the call fails (the message names the reason); the full log is in
1407
+ * {@link SFtp.lastErrorText}.
1408
+ */
1409
+ getFileLastAccessStr(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): string
1410
+
1411
+ /**
1412
+ * Asynchronous form of {@link SFtp.getFileLastAccessStr}: the same call on a native worker
1413
+ * thread,
1414
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1415
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1416
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1417
+ *
1418
+ * The promise rejects with an Error if the call fails; the full log is in
1419
+ * {@link SFtp.lastErrorText}.
1420
+ */
1421
+ getFileLastAccessStrAsync(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): Promise<string>
1422
+
1423
+ /**
1424
+ * Returns the remote file's last-modified date and time. `pathOrHandle` may contain a remote path
1425
+ * or a handle returned by {@link SFtp.openFile}. Set `bIsHandle` to `true` for a handle and
1426
+ * `false` for a path.
1427
+ *
1428
+ * When `bFollowLinks` is `true`, the server follows a symbolic link and returns metadata for its
1429
+ * target.
1430
+ *
1431
+ * The result is an RFC 822 formatted string, for example `Fri, 21 Nov 1997 09:55:06 -0600`.
1432
+ *
1433
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1434
+ * {@link SFtp.getFileLastModifiedStrAsync}.
1435
+ *
1436
+ * @throws Error if the call fails (the message names the reason); the full log is in
1437
+ * {@link SFtp.lastErrorText}.
1438
+ */
1439
+ getFileLastModifiedStr(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): string
1440
+
1441
+ /**
1442
+ * Asynchronous form of {@link SFtp.getFileLastModifiedStr}: the same call on a native worker
1443
+ * thread,
1444
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1445
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1446
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1447
+ *
1448
+ * The promise rejects with an Error if the call fails; the full log is in
1449
+ * {@link SFtp.lastErrorText}.
1450
+ */
1451
+ getFileLastModifiedStrAsync(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): Promise<string>
1452
+
1453
+ /**
1454
+ * Returns the remote file's owner. `pathOrHandle` may contain a remote path or a handle returned
1455
+ * by {@link SFtp.openFile}. Set `bIsHandle` to `true` for a handle and `false` for a path.
1456
+ *
1457
+ * When `bFollowLinks` is `true`, the server follows a symbolic link and returns metadata for its
1458
+ * target.
1459
+ *
1460
+ * With SFTP v3 and earlier, the result is the decimal numeric UID because textual owner names are
1461
+ * not supported.
1462
+ *
1463
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1464
+ * {@link SFtp.getFileOwnerAsync}.
1465
+ *
1466
+ * @throws Error if the call fails (the message names the reason); the full log is in
1467
+ * {@link SFtp.lastErrorText}.
1468
+ */
1469
+ getFileOwner(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): string
1470
+
1471
+ /**
1472
+ * Asynchronous form of {@link SFtp.getFileOwner}: the same call on a native worker thread,
1473
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1474
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1475
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1476
+ *
1477
+ * The promise rejects with an Error if the call fails; the full log is in
1478
+ * {@link SFtp.lastErrorText}.
1479
+ */
1480
+ getFileOwnerAsync(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): Promise<string>
1481
+
1482
+ /**
1483
+ * Returns the remote item's complete POSIX mode value. `pathOrHandle` may contain a remote path
1484
+ * or a handle returned by {@link SFtp.openFile}. Set `bIsHandle` to `true` for a handle and
1485
+ * `false` for a path. When `bFollowLinks` is `true`, the server follows a symbolic link and
1486
+ * returns metadata for its target.
1487
+ *
1488
+ * The returned integer includes both the file-type bits and permission bits. For example:
1489
+ *
1490
+ * ```
1491
+ * Regular file, mode 0664: octal 0100664, decimal 33204
1492
+ * Regular file, mode 0600: octal 0100600, decimal 33152
1493
+ * Regular file, mode 0644: octal 0100644, decimal 33188
1494
+ * ```
1495
+ *
1496
+ * Mask with octal `07777` to obtain permission and special bits, or `0777` for only the
1497
+ * traditional owner/group/other read, write, and execute bits. See {@link SFtp.setPermissions} to
1498
+ * change the permissions.
1499
+ *
1500
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1501
+ * {@link SFtp.getFilePermissionsAsync}.
1502
+ */
1503
+ getFilePermissions(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): number
1504
+
1505
+ /**
1506
+ * Asynchronous form of {@link SFtp.getFilePermissions}: the same call on a native worker thread,
1507
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1508
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1509
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1510
+ */
1511
+ getFilePermissionsAsync(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): Promise<number>
1512
+
1513
+ /**
1514
+ * Returns the remote file's size in bytes as a 32-bit integer. `pathOrHandle` may contain a
1515
+ * remote path or a handle returned by {@link SFtp.openFile}. Set `bIsHandle` to `true` for a
1516
+ * handle and `false` for a path.
1517
+ *
1518
+ * When `bFollowLinks` is `true`, the server follows a symbolic link and returns metadata for its
1519
+ * target.
1520
+ *
1521
+ * Returns `-1` when the size cannot be represented as a 32-bit integer. Use `GetFileSize64` or
1522
+ * `GetFileSizeStr` for large files.
1523
+ *
1524
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1525
+ * {@link SFtp.getFileSize32Async}.
1526
+ */
1527
+ getFileSize32(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): number
1528
+
1529
+ /**
1530
+ * Asynchronous form of {@link SFtp.getFileSize32}: the same call on a native worker thread,
1531
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1532
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1533
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1534
+ */
1535
+ getFileSize32Async(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): Promise<number>
1536
+
1537
+ /**
1538
+ * Returns the remote file's size in bytes as a 64-bit integer. `pathOrHandle` may contain a
1539
+ * remote path or a handle returned by {@link SFtp.openFile}. Set `bIsHandle` to `true` for a
1540
+ * handle and `false` for a path.
1541
+ *
1542
+ * When `bFollowLinks` is `true`, the server follows a symbolic link and returns metadata for its
1543
+ * target.
1544
+ *
1545
+ * 64-bit integers are passed as JavaScript numbers (exact up to 2^53).
1546
+ *
1547
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1548
+ * {@link SFtp.getFileSize64Async}.
1549
+ */
1550
+ getFileSize64(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): number
1551
+
1552
+ /**
1553
+ * Asynchronous form of {@link SFtp.getFileSize64}: the same call on a native worker thread,
1554
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1555
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1556
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1557
+ */
1558
+ getFileSize64Async(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): Promise<number>
1559
+
1560
+ /**
1561
+ * Returns the remote file's size in bytes as a decimal string. `pathOrHandle` may contain a
1562
+ * remote path or a handle returned by {@link SFtp.openFile}. Set `bIsHandle` to `true` for a
1563
+ * handle and `false` for a path.
1564
+ *
1565
+ * When `bFollowLinks` is `true`, the server follows a symbolic link and returns metadata for its
1566
+ * target.
1567
+ *
1568
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1569
+ * {@link SFtp.getFileSizeStrAsync}.
1570
+ *
1571
+ * @throws Error if the call fails (the message names the reason); the full log is in
1572
+ * {@link SFtp.lastErrorText}.
1573
+ */
1574
+ getFileSizeStr(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): string
1575
+
1576
+ /**
1577
+ * Asynchronous form of {@link SFtp.getFileSizeStr}: the same call on a native worker thread,
1578
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1579
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1580
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1581
+ *
1582
+ * The promise rejects with an Error if the call fails; the full log is in
1583
+ * {@link SFtp.lastErrorText}.
1584
+ */
1585
+ getFileSizeStrAsync(pathOrHandle: string, bFollowLinks: boolean, bIsHandle: boolean): Promise<string>
1586
+
1587
+ /**
1588
+ * Opens the SFTP subsystem and negotiates the SFTP protocol version. Call this method after
1589
+ * connecting and authenticating.
1590
+ *
1591
+ * ```
1592
+ * 1. Connect
1593
+ * 2. AuthenticatePw, AuthenticatePk, or another authentication method
1594
+ * 3. InitializeSftp
1595
+ * ```
1596
+ *
1597
+ * After success, read {@link SFtp.protocolVersion} to determine the negotiated SFTP version.
1598
+ *
1599
+ * If opening the SFTP channel fails, inspect {@link SFtp.initializeFailCode}, {@link
1600
+ * SFtp.initializeFailReason}, and `LastErrorText`.
1601
+ *
1602
+ * Call this method only once for a given SSH connection. A second call on the same connection
1603
+ * returns `false`. After disconnecting or replacing the connection, authenticate the new
1604
+ * connection and call this method again.
1605
+ *
1606
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1607
+ * {@link SFtp.initializeSftpAsync}.
1608
+ *
1609
+ * @throws Error if the call fails (the message names the reason); the full log is in
1610
+ * {@link SFtp.lastErrorText}.
1611
+ */
1612
+ initializeSftp(): void
1613
+
1614
+ /**
1615
+ * Asynchronous form of {@link SFtp.initializeSftp}: the same call on a native worker thread,
1616
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1617
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1618
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1619
+ *
1620
+ * The promise rejects with an Error if the call fails; the full log is in
1621
+ * {@link SFtp.lastErrorText}.
1622
+ */
1623
+ initializeSftpAsync(): Promise<void>
1624
+
1625
+ /**
1626
+ * Returns `true` if the most recent read associated with `handle` failed; otherwise returns
1627
+ * `false`.
1628
+ *
1629
+ * A normal end-of-file is not a read failure: the EOF read succeeds, returns zero bytes, and this
1630
+ * method returns `false`. For an empty, malformed, or already-closed handle, this method returns
1631
+ * `true`.
1632
+ */
1633
+ lastReadFailed(handle: string): boolean
1634
+
1635
+ /**
1636
+ * Returns the number of bytes received by the most recent read associated with `handle`.
1637
+ *
1638
+ * The initial value for a newly opened handle is `0`. A normal EOF read and a failed read report
1639
+ * `0`.
1640
+ */
1641
+ lastReadNumBytes(handle: string): number
1642
+
1643
+ /**
1644
+ * Opens the remote directory specified by `path` and returns a handle for reading its entries.
1645
+ *
1646
+ * ```
1647
+ * handle = OpenDir(path)
1648
+ * ReadDirListing(handle, dirObj)
1649
+ * CloseHandle(handle)
1650
+ * ```
1651
+ *
1652
+ * Remote paths use `/` as the separator. A path beginning with `/` is absolute; a relative path
1653
+ * is interpreted relative to the authenticated user's home directory. An empty path refers to
1654
+ * that default directory.
1655
+ *
1656
+ * This method does not change a working directory. SFTP is not FTP and has no persistent
1657
+ * current-directory command.
1658
+ *
1659
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1660
+ * {@link SFtp.openDirAsync}.
1661
+ *
1662
+ * @throws Error if the call fails (the message names the reason); the full log is in
1663
+ * {@link SFtp.lastErrorText}.
1664
+ */
1665
+ openDir(path: string): string
1666
+
1667
+ /**
1668
+ * Asynchronous form of {@link SFtp.openDir}: the same call on a native worker thread,
1669
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1670
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1671
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1672
+ *
1673
+ * The promise rejects with an Error if the call fails; the full log is in
1674
+ * {@link SFtp.lastErrorText}.
1675
+ */
1676
+ openDirAsync(path: string): Promise<string>
1677
+
1678
+ /**
1679
+ * Opens or creates the remote file at `remotePath` and returns a handle for subsequent read or
1680
+ * write operations. Close the handle with `CloseHandle` when finished.
1681
+ *
1682
+ * `access` must be `readOnly`, `writeOnly`, or `readWrite`.
1683
+ *
1684
+ * `createDisposition` is a comma-separated list. It must contain exactly one primary disposition:
1685
+ *
1686
+ * Primary dispositionBehavior
1687
+ *
1688
+ * | `createNew` | | Create a new file; fail if it already exists. |
1689
+ *
1690
+ * | `createTruncate` | | Create a new file, or open and truncate an existing file. |
1691
+ *
1692
+ * | `openExisting` | | Open an existing file; fail if it does not exist. |
1693
+ *
1694
+ * | `openOrCreate` | | Open the file if it exists, otherwise create it. |
1695
+ *
1696
+ * | `truncateExisting` | | Open and truncate an existing file; fail if it does not exist. |
1697
+ *
1698
+ * Additional optional keywords are:
1699
+ *
1700
+ * OptionBehavior
1701
+ *
1702
+ * | `appendData` | | Write at the end of the file. Appends are not guaranteed to be atomic. |
1703
+ *
1704
+ * | `appendDataAtomic` | | Append atomically so concurrent appenders do not collide. SFTP v5 or
1705
+ * later. |
1706
+ *
1707
+ * | `textMode` | | Request server text-mode processing and canonical newline conversion. SFTP v5
1708
+ * or later. |
1709
+ *
1710
+ * | `blockRead` | | Request exclusive read access. SFTP v5 or later. |
1711
+ *
1712
+ * | `blockWrite` | | Request exclusive write access. SFTP v5 or later. |
1713
+ *
1714
+ * | `blockDelete` | | Prevent deletion while the handle is open. SFTP v5 or later. |
1715
+ *
1716
+ * | `blockAdvisory` | | Make the requested block modes advisory. SFTP v5 or later. |
1717
+ *
1718
+ * | `noFollow` | | Fail if the final path component is a symbolic link. SFTP v5 or later. |
1719
+ *
1720
+ * | `deleteOnClose` | | Request deletion when the last handle is closed. SFTP v5 or later. |
1721
+ *
1722
+ * | `accessAuditAlarmInfo` | | Request privileges needed to read or write AUDIT or ALARM ACL
1723
+ * entries. SFTP v5 or later. |
1724
+ *
1725
+ * | `accessBackup` | | Request backup/restore privileges that may bypass normal access checks.
1726
+ * SFTP v5 or later. |
1727
+ *
1728
+ * | `backupStream` | | Read or write a server-specific backup stream. SFTP v5 or later. |
1729
+ *
1730
+ * Options marked SFTP v5 or later require {@link SFtp.forceV3} to be `false` and a negotiated
1731
+ * {@link SFtp.protocolVersion} of at least `5`.
1732
+ *
1733
+ * An absolute remote path begins with `/`. A relative path is interpreted from the authenticated
1734
+ * user's home directory. Some servers require a filename in the home directory to be written as
1735
+ * `./filename`.
1736
+ *
1737
+ * **Use only documented values:** Some servers or Chilkat versions may tolerate an unknown access
1738
+ * value, an unknown option, or conflicting primary dispositions, but the resulting behavior is
1739
+ * unspecified. Supply one documented access value and exactly one primary disposition.
1740
+ *
1741
+ * `appendData` forces writes to the end of the file, including explicit-offset writes. By itself
1742
+ * it opens an existing file but does not create a missing file; combine it with an appropriate
1743
+ * primary disposition when creation is required. Options defined for SFTP v5 or later must not be
1744
+ * assumed to take effect when an older version is negotiated, even if the open request succeeds.
1745
+ *
1746
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1747
+ * {@link SFtp.openFileAsync}.
1748
+ *
1749
+ * @throws Error if the call fails (the message names the reason); the full log is in
1750
+ * {@link SFtp.lastErrorText}.
1751
+ */
1752
+ openFile(remotePath: string, access: string, createDisposition: string): string
1753
+
1754
+ /**
1755
+ * Asynchronous form of {@link SFtp.openFile}: the same call on a native worker thread,
1756
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1757
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1758
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1759
+ *
1760
+ * The promise rejects with an Error if the call fails; the full log is in
1761
+ * {@link SFtp.lastErrorText}.
1762
+ */
1763
+ openFileAsync(remotePath: string, access: string, createDisposition: string): Promise<string>
1764
+
1765
+ /**
1766
+ * Reads up to `numBytes` bytes from the current position of `handle`, decodes the bytes using
1767
+ * `charset`, and returns the resulting text.
1768
+ *
1769
+ * See [Supported Charsets](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp).
1770
+ *
1771
+ * The requested size is measured in bytes, not characters. With a multibyte encoding such as
1772
+ * UTF-8 or Shift_JIS, the final character can be split across calls. For robust streaming, read
1773
+ * raw bytes and decode with application-maintained state.
1774
+ *
1775
+ * **Multibyte boundaries:** Chilkat does not retain an incomplete multibyte character between
1776
+ * calls. If `numBytes` ends in the middle of a UTF-8 sequence, the first returned string ends
1777
+ * with the incomplete bytes and the next call begins with the remaining bytes. Choose byte counts
1778
+ * that end on character boundaries, or read bytes and perform streaming decoding in the
1779
+ * application.
1780
+ *
1781
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1782
+ * {@link SFtp.readFileTextAsync}.
1783
+ *
1784
+ * @throws Error if the call fails (the message names the reason); the full log is in
1785
+ * {@link SFtp.lastErrorText}.
1786
+ */
1787
+ readFileText(handle: string, numBytes: number, charset: string): string
1788
+
1789
+ /**
1790
+ * Asynchronous form of {@link SFtp.readFileText}: the same call on a native worker thread,
1791
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1792
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1793
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1794
+ *
1795
+ * The promise rejects with an Error if the call fails; the full log is in
1796
+ * {@link SFtp.lastErrorText}.
1797
+ */
1798
+ readFileTextAsync(handle: string, numBytes: number, charset: string): Promise<string>
1799
+
1800
+ /**
1801
+ * Reads up to `numBytes` bytes from `handle` at the 32-bit byte `offset`, decodes the bytes using
1802
+ * `charset`, and returns the resulting text.
1803
+ *
1804
+ * See [Supported Charsets](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp).
1805
+ *
1806
+ * The requested size is measured in bytes, not characters. With a multibyte encoding such as
1807
+ * UTF-8 or Shift_JIS, the final character can be split across calls. For robust streaming, read
1808
+ * raw bytes and decode with application-maintained state.
1809
+ *
1810
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1811
+ * {@link SFtp.readFileText32Async}.
1812
+ *
1813
+ * @throws Error if the call fails (the message names the reason); the full log is in
1814
+ * {@link SFtp.lastErrorText}.
1815
+ */
1816
+ readFileText32(handle: string, offset: number, numBytes: number, charset: string): string
1817
+
1818
+ /**
1819
+ * Asynchronous form of {@link SFtp.readFileText32}: the same call on a native worker thread,
1820
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1821
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1822
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1823
+ *
1824
+ * The promise rejects with an Error if the call fails; the full log is in
1825
+ * {@link SFtp.lastErrorText}.
1826
+ */
1827
+ readFileText32Async(handle: string, offset: number, numBytes: number, charset: string): Promise<string>
1828
+
1829
+ /**
1830
+ * Reads up to `numBytes` bytes from `handle` at the 64-bit byte `offset`, decodes the bytes using
1831
+ * `charset`, and returns the resulting text.
1832
+ *
1833
+ * See [Supported Charsets](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp).
1834
+ *
1835
+ * The requested size is measured in bytes, not characters. With a multibyte encoding such as
1836
+ * UTF-8 or Shift_JIS, the final character can be split across calls. For robust streaming, read
1837
+ * raw bytes and decode with application-maintained state.
1838
+ *
1839
+ * 64-bit integers are passed as JavaScript numbers (exact up to 2^53).
1840
+ *
1841
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1842
+ * {@link SFtp.readFileText64Async}.
1843
+ *
1844
+ * @throws Error if the call fails (the message names the reason); the full log is in
1845
+ * {@link SFtp.lastErrorText}.
1846
+ */
1847
+ readFileText64(handle: string, offset: number, numBytes: number, charset: string): string
1848
+
1849
+ /**
1850
+ * Asynchronous form of {@link SFtp.readFileText64}: the same call on a native worker thread,
1851
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1852
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1853
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1854
+ *
1855
+ * The promise rejects with an Error if the call fails; the full log is in
1856
+ * {@link SFtp.lastErrorText}.
1857
+ */
1858
+ readFileText64Async(handle: string, offset: number, numBytes: number, charset: string): Promise<string>
1859
+
1860
+ /**
1861
+ * Reads up to `numBytes` bytes from `handle` at the byte offset supplied as decimal string
1862
+ * `offset`, decodes the bytes using `charset`, and returns the resulting text.
1863
+ *
1864
+ * See [Supported Charsets](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp).
1865
+ *
1866
+ * The requested size is measured in bytes, not characters. With a multibyte encoding, the final
1867
+ * character can be split across calls.
1868
+ *
1869
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1870
+ * {@link SFtp.readFileText64sAsync}.
1871
+ *
1872
+ * @throws Error if the call fails (the message names the reason); the full log is in
1873
+ * {@link SFtp.lastErrorText}.
1874
+ */
1875
+ readFileText64s(handle: string, offset: string, numBytes: number, charset: string): string
1876
+
1877
+ /**
1878
+ * Asynchronous form of {@link SFtp.readFileText64s}: the same call on a native worker thread,
1879
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1880
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1881
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1882
+ *
1883
+ * The promise rejects with an Error if the call fails; the full log is in
1884
+ * {@link SFtp.lastErrorText}.
1885
+ */
1886
+ readFileText64sAsync(handle: string, offset: string, numBytes: number, charset: string): Promise<string>
1887
+
1888
+ /**
1889
+ * Asks the server to canonicalize `originalPath` and returns the resulting absolute remote path.
1890
+ *
1891
+ * For SFTP v5 or later, `composePath` may optionally modify or extend the original path; pass an
1892
+ * empty string when no composition is needed. If `composePath` is absolute, it replaces
1893
+ * `originalPath`.
1894
+ *
1895
+ * SFTP v3 and v4 do not support path composition. On those versions, `composePath` is ignored and
1896
+ * the method canonicalizes only `originalPath`.
1897
+ *
1898
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1899
+ * {@link SFtp.realPathAsync}.
1900
+ *
1901
+ * @throws Error if the call fails (the message names the reason); the full log is in
1902
+ * {@link SFtp.lastErrorText}.
1903
+ */
1904
+ realPath(originalPath: string, composePath: string): string
1905
+
1906
+ /**
1907
+ * Asynchronous form of {@link SFtp.realPath}: the same call on a native worker thread,
1908
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1909
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1910
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1911
+ *
1912
+ * The promise rejects with an Error if the call fails; the full log is in
1913
+ * {@link SFtp.lastErrorText}.
1914
+ */
1915
+ realPathAsync(originalPath: string, composePath: string): Promise<string>
1916
+
1917
+ /**
1918
+ * Deletes the remote directory specified by `path`.
1919
+ *
1920
+ * Most SFTP servers require the directory to be empty before it can be removed.
1921
+ *
1922
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1923
+ * {@link SFtp.removeDirAsync}.
1924
+ *
1925
+ * @throws Error if the call fails (the message names the reason); the full log is in
1926
+ * {@link SFtp.lastErrorText}.
1927
+ */
1928
+ removeDir(path: string): void
1929
+
1930
+ /**
1931
+ * Asynchronous form of {@link SFtp.removeDir}: the same call on a native worker thread,
1932
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1933
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1934
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1935
+ *
1936
+ * The promise rejects with an Error if the call fails; the full log is in
1937
+ * {@link SFtp.lastErrorText}.
1938
+ */
1939
+ removeDirAsync(path: string): Promise<void>
1940
+
1941
+ /**
1942
+ * Deletes the remote file specified by `filename`.
1943
+ *
1944
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1945
+ * {@link SFtp.removeFileAsync}.
1946
+ *
1947
+ * @throws Error if the call fails (the message names the reason); the full log is in
1948
+ * {@link SFtp.lastErrorText}.
1949
+ */
1950
+ removeFile(filename: string): void
1951
+
1952
+ /**
1953
+ * Asynchronous form of {@link SFtp.removeFile}: the same call on a native worker thread,
1954
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1955
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1956
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1957
+ *
1958
+ * The promise rejects with an Error if the call fails; the full log is in
1959
+ * {@link SFtp.lastErrorText}.
1960
+ */
1961
+ removeFileAsync(filename: string): Promise<void>
1962
+
1963
+ /**
1964
+ * Renames or moves a remote file or directory from `oldPath` to `newPath`.
1965
+ *
1966
+ * ```
1967
+ * oldPath: someDirA/filename
1968
+ * newPath: someDirB/abc/xyz/filename
1969
+ * ```
1970
+ *
1971
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1972
+ * {@link SFtp.renameFileOrDirAsync}.
1973
+ *
1974
+ * @throws Error if the call fails (the message names the reason); the full log is in
1975
+ * {@link SFtp.lastErrorText}.
1976
+ */
1977
+ renameFileOrDir(oldPath: string, newPath: string): void
1978
+
1979
+ /**
1980
+ * Asynchronous form of {@link SFtp.renameFileOrDir}: the same call on a native worker thread,
1981
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1982
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
1983
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
1984
+ *
1985
+ * The promise rejects with an Error if the call fails; the full log is in
1986
+ * {@link SFtp.lastErrorText}.
1987
+ */
1988
+ renameFileOrDirAsync(oldPath: string, newPath: string): Promise<void>
1989
+
1990
+ /**
1991
+ * Resumes downloading `remoteFilePath` to the local filesystem path `localFilePath`. Chilkat uses
1992
+ * only the existing local file size as the remote starting offset.
1993
+ *
1994
+ * - If the local file is missing or empty, a normal download is performed.
1995
+ *
1996
+ * - If it is smaller, the remaining remote bytes are appended after the existing local length.
1997
+ *
1998
+ * - If it is the same size or larger, the method treats the download as complete and does not
1999
+ * truncate or verify the local content.
2000
+ *
2001
+ * **Important:** The existing local bytes are not compared with the remote source. Before
2002
+ * resuming, the application must ensure that the local file is the correct prefix of the remote
2003
+ * file.
2004
+ *
2005
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2006
+ * {@link SFtp.resumeDownloadFileByNameAsync}.
2007
+ *
2008
+ * @throws Error if the call fails (the message names the reason); the full log is in
2009
+ * {@link SFtp.lastErrorText}.
2010
+ */
2011
+ resumeDownloadFileByName(remoteFilePath: string, localFilePath: string): void
2012
+
2013
+ /**
2014
+ * Asynchronous form of {@link SFtp.resumeDownloadFileByName}: the same call on a native worker
2015
+ * thread,
2016
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2017
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2018
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2019
+ *
2020
+ * The promise rejects with an Error if the call fails; the full log is in
2021
+ * {@link SFtp.lastErrorText}.
2022
+ */
2023
+ resumeDownloadFileByNameAsync(remoteFilePath: string, localFilePath: string): Promise<void>
2024
+
2025
+ /**
2026
+ * Resumes uploading the local file at `localFilePath` to `remoteFilePath`. Chilkat uses only the
2027
+ * existing remote file size as the local starting offset.
2028
+ *
2029
+ * - If the remote file is missing or empty, a normal upload is performed.
2030
+ *
2031
+ * - If it is smaller, the remaining local bytes are appended after the existing remote length.
2032
+ *
2033
+ * - If it is the same size or larger, the method treats the upload as complete and does not
2034
+ * truncate or verify the remote content.
2035
+ *
2036
+ * **Important:** The existing remote bytes are not compared with the local source. Before
2037
+ * resuming, the application must ensure that the remote file is the correct prefix of the local
2038
+ * file.
2039
+ *
2040
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2041
+ * {@link SFtp.resumeUploadFileByNameAsync}.
2042
+ *
2043
+ * @throws Error if the call fails (the message names the reason); the full log is in
2044
+ * {@link SFtp.lastErrorText}.
2045
+ */
2046
+ resumeUploadFileByName(remoteFilePath: string, localFilePath: string): void
2047
+
2048
+ /**
2049
+ * Asynchronous form of {@link SFtp.resumeUploadFileByName}: the same call on a native worker
2050
+ * thread,
2051
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2052
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2053
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2054
+ *
2055
+ * The promise rejects with an Error if the call fails; the full log is in
2056
+ * {@link SFtp.lastErrorText}.
2057
+ */
2058
+ resumeUploadFileByNameAsync(remoteFilePath: string, localFilePath: string): Promise<void>
2059
+
2060
+ /**
2061
+ * Sets the remote file's creation date and time. `pathOrHandle` may contain a remote path or an
2062
+ * open handle. Set `isHandle` to `true` for a handle and `false` for a path.
2063
+ *
2064
+ * SFTP v3 and earlier do not support setting creation time.
2065
+ *
2066
+ * `createDateTime` supplies the new value.
2067
+ *
2068
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2069
+ * {@link SFtp.setCreateDtAsync}.
2070
+ *
2071
+ * @throws Error if the call fails (the message names the reason); the full log is in
2072
+ * {@link SFtp.lastErrorText}.
2073
+ */
2074
+ setCreateDt(pathOrHandle: string, isHandle: boolean, createDateTime: CkDateTime): void
2075
+
2076
+ /**
2077
+ * Asynchronous form of {@link SFtp.setCreateDt}: the same call on a native worker thread,
2078
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2079
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2080
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2081
+ *
2082
+ * The promise rejects with an Error if the call fails; the full log is in
2083
+ * {@link SFtp.lastErrorText}.
2084
+ */
2085
+ setCreateDtAsync(pathOrHandle: string, isHandle: boolean, createDateTime: CkDateTime): Promise<void>
2086
+
2087
+ /**
2088
+ * Sets the remote file's creation date and time. `pathOrHandle` may contain a remote path or an
2089
+ * open handle. Set `bIsHandle` to `true` for a handle and `false` for a path.
2090
+ *
2091
+ * Pass the value in `dateTimeStr` as an RFC 822 formatted string, for example `Fri, 21 Nov 1997
2092
+ * 09:55:06 -0600`.
2093
+ *
2094
+ * SFTP v3 and earlier do not support setting creation time.
2095
+ *
2096
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2097
+ * {@link SFtp.setCreateTimeStrAsync}.
2098
+ *
2099
+ * @throws Error if the call fails (the message names the reason); the full log is in
2100
+ * {@link SFtp.lastErrorText}.
2101
+ */
2102
+ setCreateTimeStr(pathOrHandle: string, bIsHandle: boolean, dateTimeStr: string): void
2103
+
2104
+ /**
2105
+ * Asynchronous form of {@link SFtp.setCreateTimeStr}: the same call on a native worker thread,
2106
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2107
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2108
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2109
+ *
2110
+ * The promise rejects with an Error if the call fails; the full log is in
2111
+ * {@link SFtp.lastErrorText}.
2112
+ */
2113
+ setCreateTimeStrAsync(pathOrHandle: string, bIsHandle: boolean, dateTimeStr: string): Promise<void>
2114
+
2115
+ /**
2116
+ * Sets the remote file's last-access date and time. `pathOrHandle` may contain a remote path or
2117
+ * an open handle. Set `isHandle` to `true` for a handle and `false` for a path.
2118
+ *
2119
+ * `accessDateTime` supplies the new value.
2120
+ *
2121
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2122
+ * {@link SFtp.setLastAccessDtAsync}.
2123
+ *
2124
+ * @throws Error if the call fails (the message names the reason); the full log is in
2125
+ * {@link SFtp.lastErrorText}.
2126
+ */
2127
+ setLastAccessDt(pathOrHandle: string, isHandle: boolean, accessDateTime: CkDateTime): void
2128
+
2129
+ /**
2130
+ * Asynchronous form of {@link SFtp.setLastAccessDt}: the same call on a native worker thread,
2131
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2132
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2133
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2134
+ *
2135
+ * The promise rejects with an Error if the call fails; the full log is in
2136
+ * {@link SFtp.lastErrorText}.
2137
+ */
2138
+ setLastAccessDtAsync(pathOrHandle: string, isHandle: boolean, accessDateTime: CkDateTime): Promise<void>
2139
+
2140
+ /**
2141
+ * Sets the remote file's last-access date and time. `pathOrHandle` may contain a remote path or
2142
+ * an open handle. Set `bIsHandle` to `true` for a handle and `false` for a path.
2143
+ *
2144
+ * Pass the value in `dateTimeStr` as an RFC 822 formatted string, for example `Fri, 21 Nov 1997
2145
+ * 09:55:06 -0600`.
2146
+ *
2147
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2148
+ * {@link SFtp.setLastAccessTimeStrAsync}.
2149
+ *
2150
+ * @throws Error if the call fails (the message names the reason); the full log is in
2151
+ * {@link SFtp.lastErrorText}.
2152
+ */
2153
+ setLastAccessTimeStr(pathOrHandle: string, bIsHandle: boolean, dateTimeStr: string): void
2154
+
2155
+ /**
2156
+ * Asynchronous form of {@link SFtp.setLastAccessTimeStr}: the same call on a native worker
2157
+ * thread,
2158
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2159
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2160
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2161
+ *
2162
+ * The promise rejects with an Error if the call fails; the full log is in
2163
+ * {@link SFtp.lastErrorText}.
2164
+ */
2165
+ setLastAccessTimeStrAsync(pathOrHandle: string, bIsHandle: boolean, dateTimeStr: string): Promise<void>
2166
+
2167
+ /**
2168
+ * Sets the remote file's last-modified date and time. `pathOrHandle` may contain a remote path or
2169
+ * an open handle. Set `isHandle` to `true` for a handle and `false` for a path.
2170
+ *
2171
+ * `modifiedDateTime` supplies the new value.
2172
+ *
2173
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2174
+ * {@link SFtp.setLastModifiedDtAsync}.
2175
+ *
2176
+ * @throws Error if the call fails (the message names the reason); the full log is in
2177
+ * {@link SFtp.lastErrorText}.
2178
+ */
2179
+ setLastModifiedDt(pathOrHandle: string, isHandle: boolean, modifiedDateTime: CkDateTime): void
2180
+
2181
+ /**
2182
+ * Asynchronous form of {@link SFtp.setLastModifiedDt}: the same call on a native worker thread,
2183
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2184
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2185
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2186
+ *
2187
+ * The promise rejects with an Error if the call fails; the full log is in
2188
+ * {@link SFtp.lastErrorText}.
2189
+ */
2190
+ setLastModifiedDtAsync(pathOrHandle: string, isHandle: boolean, modifiedDateTime: CkDateTime): Promise<void>
2191
+
2192
+ /**
2193
+ * Sets the remote file's last-modified date and time. `pathOrHandle` may contain a remote path or
2194
+ * an open handle. Set `bIsHandle` to `true` for a handle and `false` for a path.
2195
+ *
2196
+ * Pass the value in `dateTimeStr` as an RFC 822 formatted string, for example `Fri, 21 Nov 1997
2197
+ * 09:55:06 -0600`.
2198
+ *
2199
+ * When SFTP v3 is negotiated, the stored timestamp has whole-second precision.
2200
+ *
2201
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2202
+ * {@link SFtp.setLastModifiedTimeStrAsync}.
2203
+ *
2204
+ * @throws Error if the call fails (the message names the reason); the full log is in
2205
+ * {@link SFtp.lastErrorText}.
2206
+ */
2207
+ setLastModifiedTimeStr(pathOrHandle: string, bIsHandle: boolean, dateTimeStr: string): void
2208
+
2209
+ /**
2210
+ * Asynchronous form of {@link SFtp.setLastModifiedTimeStr}: the same call on a native worker
2211
+ * thread,
2212
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2213
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2214
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2215
+ *
2216
+ * The promise rejects with an Error if the call fails; the full log is in
2217
+ * {@link SFtp.lastErrorText}.
2218
+ */
2219
+ setLastModifiedTimeStrAsync(pathOrHandle: string, bIsHandle: boolean, dateTimeStr: string): Promise<void>
2220
+
2221
+ /**
2222
+ * Sets the owner and group of the remote item identified by `pathOrHandle`. Set `isHandle` to
2223
+ * `true` for an open handle and `false` for a remote path.
2224
+ *
2225
+ * `owner` and `group` supply the new textual owner and group values.
2226
+ *
2227
+ * SFTP v3 and earlier do not support textual owner and group names.
2228
+ *
2229
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2230
+ * {@link SFtp.setOwnerAndGroupAsync}.
2231
+ *
2232
+ * @throws Error if the call fails (the message names the reason); the full log is in
2233
+ * {@link SFtp.lastErrorText}.
2234
+ */
2235
+ setOwnerAndGroup(pathOrHandle: string, isHandle: boolean, owner: string, group: string): void
2236
+
2237
+ /**
2238
+ * Asynchronous form of {@link SFtp.setOwnerAndGroup}: the same call on a native worker thread,
2239
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2240
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2241
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2242
+ *
2243
+ * The promise rejects with an Error if the call fails; the full log is in
2244
+ * {@link SFtp.lastErrorText}.
2245
+ */
2246
+ setOwnerAndGroupAsync(pathOrHandle: string, isHandle: boolean, owner: string, group: string): Promise<void>
2247
+
2248
+ /**
2249
+ * Sets the POSIX permission bits for the remote item identified by `pathOrHandle`. Set `isHandle`
2250
+ * to `true` for an open handle and `false` for a remote path.
2251
+ *
2252
+ * Pass the permission bits, not the file-type bits. In languages supporting octal integer
2253
+ * literals, common values include `0600`, `0644`, and `0755`. Their decimal equivalents are
2254
+ * `384`, `420`, and `493`.
2255
+ *
2256
+ * After setting permissions, {@link SFtp.getFilePermissions} returns the complete mode, including
2257
+ * the file-type bits. For example, setting `0644` on a regular file can subsequently return
2258
+ * `0100644`.
2259
+ *
2260
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2261
+ * {@link SFtp.setPermissionsAsync}.
2262
+ *
2263
+ * @throws Error if the call fails (the message names the reason); the full log is in
2264
+ * {@link SFtp.lastErrorText}.
2265
+ */
2266
+ setPermissions(pathOrHandle: string, isHandle: boolean, permissions: number): void
2267
+
2268
+ /**
2269
+ * Asynchronous form of {@link SFtp.setPermissions}: the same call on a native worker thread,
2270
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2271
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2272
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2273
+ *
2274
+ * The promise rejects with an Error if the call fails; the full log is in
2275
+ * {@link SFtp.lastErrorText}.
2276
+ */
2277
+ setPermissionsAsync(pathOrHandle: string, isHandle: boolean, permissions: number): Promise<void>
2278
+
2279
+ /**
2280
+ * Synchronizes files from the remote directory `remoteRoot` to the local filesystem directory
2281
+ * `localRoot`.
2282
+ *
2283
+ * ModeBehavior
2284
+ *
2285
+ * | `0` | | Download all files. |
2286
+ *
2287
+ * | `1` | | Download files that do not exist locally. |
2288
+ *
2289
+ * | `2` | | Download files that are newer remotely or missing locally. |
2290
+ *
2291
+ * | `3` | | Download only files that are newer remotely; do not download missing local files. |
2292
+ *
2293
+ * | `5` | | Download files that are missing locally or differ in size. |
2294
+ *
2295
+ * | `6` | | Mode 5 plus files that are newer remotely. |
2296
+ *
2297
+ * | `99` | | Do not download; delete remote files that do not exist locally. |
2298
+ *
2299
+ * Set `recurse` to `true` to descend into subdirectories. An absolute remote path begins with
2300
+ * `/`; a relative path is interpreted from the authenticated user's home directory.
2301
+ *
2302
+ * Use {@link SFtp.getSyncedFiles} after the operation to retrieve the relative paths that were
2303
+ * downloaded or created.
2304
+ *
2305
+ * With {@link SFtp.syncCreateAllLocalDirs} set to `true`, mode `0` creates empty remote
2306
+ * directories locally. Mode `1` downloads only missing local files and preserves existing local
2307
+ * files. Mode `99` deletes files from the remote tree that are absent locally; it does not delete
2308
+ * extra local files.
2309
+ *
2310
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2311
+ * {@link SFtp.syncTreeDownloadAsync}.
2312
+ *
2313
+ * @throws Error if the call fails (the message names the reason); the full log is in
2314
+ * {@link SFtp.lastErrorText}.
2315
+ */
2316
+ syncTreeDownload(remoteRoot: string, localRoot: string, mode: number, recurse: boolean): void
2317
+
2318
+ /**
2319
+ * Asynchronous form of {@link SFtp.syncTreeDownload}: the same call on a native worker thread,
2320
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2321
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2322
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2323
+ *
2324
+ * The promise rejects with an Error if the call fails; the full log is in
2325
+ * {@link SFtp.lastErrorText}.
2326
+ */
2327
+ syncTreeDownloadAsync(remoteRoot: string, localRoot: string, mode: number, recurse: boolean): Promise<void>
2328
+
2329
+ /**
2330
+ * Synchronizes files from the local filesystem directory `localBaseDir` to the remote directory
2331
+ * `remoteBaseDir`.
2332
+ *
2333
+ * ModeBehavior
2334
+ *
2335
+ * | `0` | | Upload all files. |
2336
+ *
2337
+ * | `1` | | Upload files that do not exist remotely. |
2338
+ *
2339
+ * | `2` | | Upload files that are newer locally or missing remotely. |
2340
+ *
2341
+ * | `3` | | Upload only files that are newer locally; do not upload missing remote files. |
2342
+ *
2343
+ * | `4` | | Upload files that are missing remotely or differ in size. |
2344
+ *
2345
+ * | `5` | | Mode 4 plus files that are newer locally. |
2346
+ *
2347
+ * Set `bRecurse` to `true` to descend into subdirectories. An absolute remote path begins with
2348
+ * `/`; a relative path is interpreted from the authenticated user's home directory.
2349
+ *
2350
+ * Use {@link SFtp.getSyncedFiles} after the operation to retrieve the relative paths that were
2351
+ * uploaded.
2352
+ *
2353
+ * Mode `0` also creates empty remote directories. Mode `1` uploads only missing files and does
2354
+ * not replace an existing remote file merely because the local file is newer; use mode `2` for
2355
+ * missing-or-newer behavior. The filename and directory filters are applied during recursive
2356
+ * traversal.
2357
+ *
2358
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2359
+ * {@link SFtp.syncTreeUploadAsync}.
2360
+ *
2361
+ * @throws Error if the call fails (the message names the reason); the full log is in
2362
+ * {@link SFtp.lastErrorText}.
2363
+ */
2364
+ syncTreeUpload(localBaseDir: string, remoteBaseDir: string, mode: number, bRecurse: boolean): void
2365
+
2366
+ /**
2367
+ * Asynchronous form of {@link SFtp.syncTreeUpload}: the same call on a native worker thread,
2368
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2369
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2370
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2371
+ *
2372
+ * The promise rejects with an Error if the call fails; the full log is in
2373
+ * {@link SFtp.lastErrorText}.
2374
+ */
2375
+ syncTreeUploadAsync(localBaseDir: string, remoteBaseDir: string, mode: number, bRecurse: boolean): Promise<void>
2376
+
2377
+ /**
2378
+ * Streams the local filesystem file at `fromLocalFilePath` to the remote file identified by
2379
+ * `handle`. The handle must have been returned by {@link SFtp.openFile}.
2380
+ *
2381
+ * Close the remote handle when the upload is complete.
2382
+ *
2383
+ * The upload begins at the handle's current sequential write position. Existing bytes before that
2384
+ * position are preserved unless the file was truncated when opened.
2385
+ *
2386
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2387
+ * {@link SFtp.uploadFileAsync}.
2388
+ *
2389
+ * @throws Error if the call fails (the message names the reason); the full log is in
2390
+ * {@link SFtp.lastErrorText}.
2391
+ */
2392
+ uploadFile(handle: string, fromLocalFilePath: string): void
2393
+
2394
+ /**
2395
+ * Asynchronous form of {@link SFtp.uploadFile}: the same call on a native worker thread,
2396
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2397
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2398
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2399
+ *
2400
+ * The promise rejects with an Error if the call fails; the full log is in
2401
+ * {@link SFtp.lastErrorText}.
2402
+ */
2403
+ uploadFileAsync(handle: string, fromLocalFilePath: string): Promise<void>
2404
+
2405
+ /**
2406
+ * Uploads the local filesystem file at `localFilePath` to `remoteFilePath`.
2407
+ *
2408
+ * When {@link SFtp.preserveDate} is `true`, Chilkat preserves the local file's last-modified time
2409
+ * on the remote file.
2410
+ *
2411
+ * An absolute remote path begins with `/` and is relative to the server filesystem root. A
2412
+ * relative path is interpreted relative to the authenticated user's home directory.
2413
+ *
2414
+ * If the destination exists, it is truncated before the upload. A zero-byte local file creates or
2415
+ * truncates the remote file to zero bytes. Missing remote parent directories are not created
2416
+ * automatically.
2417
+ *
2418
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2419
+ * {@link SFtp.uploadFileByNameAsync}.
2420
+ *
2421
+ * @throws Error if the call fails (the message names the reason); the full log is in
2422
+ * {@link SFtp.lastErrorText}.
2423
+ */
2424
+ uploadFileByName(remoteFilePath: string, localFilePath: string): void
2425
+
2426
+ /**
2427
+ * Asynchronous form of {@link SFtp.uploadFileByName}: the same call on a native worker thread,
2428
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2429
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2430
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2431
+ *
2432
+ * The promise rejects with an Error if the call fails; the full log is in
2433
+ * {@link SFtp.lastErrorText}.
2434
+ */
2435
+ uploadFileByNameAsync(remoteFilePath: string, localFilePath: string): Promise<void>
2436
+
2437
+ /**
2438
+ * Encodes `textData` using `charset` and writes the resulting bytes at the current sequential
2439
+ * write position for `handle`.
2440
+ *
2441
+ * The position is maintained by Chilkat for the handle. Opening an existing file with
2442
+ * `openOrCreate` positions sequential writes at the current end of the file. An explicit-offset
2443
+ * write can change the position used by the next sequential write. When the file was opened with
2444
+ * `appendData`, writes are forced to the end.
2445
+ *
2446
+ * See [Supported Charsets](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp).
2447
+ *
2448
+ * No byte-order mark or line ending is added unless it is present in the supplied text or
2449
+ * produced by the selected encoding.
2450
+ *
2451
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2452
+ * {@link SFtp.writeFileTextAsync}.
2453
+ *
2454
+ * @throws Error if the call fails (the message names the reason); the full log is in
2455
+ * {@link SFtp.lastErrorText}.
2456
+ */
2457
+ writeFileText(handle: string, charset: string, textData: string): void
2458
+
2459
+ /**
2460
+ * Asynchronous form of {@link SFtp.writeFileText}: the same call on a native worker thread,
2461
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2462
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2463
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2464
+ *
2465
+ * The promise rejects with an Error if the call fails; the full log is in
2466
+ * {@link SFtp.lastErrorText}.
2467
+ */
2468
+ writeFileTextAsync(handle: string, charset: string, textData: string): Promise<void>
2469
+
2470
+ /**
2471
+ * Encodes `textData` using `charset` and writes the resulting bytes to `handle` at the 32-bit
2472
+ * byte offset `offset32`.
2473
+ *
2474
+ * After a successful explicit-offset write, the next sequential write begins immediately after
2475
+ * the bytes written by this call. If the file was opened with `appendData`, the server appends
2476
+ * and the explicit offset does not control placement.
2477
+ *
2478
+ * See [Supported Charsets](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp).
2479
+ *
2480
+ * `offset32` must be nonnegative. A negative value can be interpreted as a very large unsigned
2481
+ * offset. Writing beyond end-of-file can create a sparse file; whether the gap is sparse is
2482
+ * determined by the server filesystem.
2483
+ *
2484
+ * No byte-order mark or line ending is added unless it is present in the supplied text or
2485
+ * produced by the selected encoding.
2486
+ *
2487
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2488
+ * {@link SFtp.writeFileText32Async}.
2489
+ *
2490
+ * @throws Error if the call fails (the message names the reason); the full log is in
2491
+ * {@link SFtp.lastErrorText}.
2492
+ */
2493
+ writeFileText32(handle: string, offset32: number, charset: string, textData: string): void
2494
+
2495
+ /**
2496
+ * Asynchronous form of {@link SFtp.writeFileText32}: the same call on a native worker thread,
2497
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2498
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2499
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2500
+ *
2501
+ * The promise rejects with an Error if the call fails; the full log is in
2502
+ * {@link SFtp.lastErrorText}.
2503
+ */
2504
+ writeFileText32Async(handle: string, offset32: number, charset: string, textData: string): Promise<void>
2505
+
2506
+ /**
2507
+ * Encodes `textData` using `charset` and writes the resulting bytes to `handle` at the 64-bit
2508
+ * byte offset `offset64`.
2509
+ *
2510
+ * See [Supported Charsets](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp).
2511
+ *
2512
+ * No byte-order mark or line ending is added unless it is present in the supplied text or
2513
+ * produced by the selected encoding.
2514
+ *
2515
+ * 64-bit integers are passed as JavaScript numbers (exact up to 2^53).
2516
+ *
2517
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2518
+ * {@link SFtp.writeFileText64Async}.
2519
+ *
2520
+ * @throws Error if the call fails (the message names the reason); the full log is in
2521
+ * {@link SFtp.lastErrorText}.
2522
+ */
2523
+ writeFileText64(handle: string, offset64: number, charset: string, textData: string): void
2524
+
2525
+ /**
2526
+ * Asynchronous form of {@link SFtp.writeFileText64}: the same call on a native worker thread,
2527
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2528
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2529
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2530
+ *
2531
+ * The promise rejects with an Error if the call fails; the full log is in
2532
+ * {@link SFtp.lastErrorText}.
2533
+ */
2534
+ writeFileText64Async(handle: string, offset64: number, charset: string, textData: string): Promise<void>
2535
+
2536
+ /**
2537
+ * Encodes `textData` using `charset` and writes the resulting bytes to `handle` at the byte
2538
+ * offset supplied as decimal string `offset64`.
2539
+ *
2540
+ * See [Supported Charsets](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp).
2541
+ *
2542
+ * No byte-order mark or line ending is added unless it is present in the supplied text or
2543
+ * produced by the selected encoding.
2544
+ *
2545
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2546
+ * {@link SFtp.writeFileText64sAsync}.
2547
+ *
2548
+ * @throws Error if the call fails (the message names the reason); the full log is in
2549
+ * {@link SFtp.lastErrorText}.
2550
+ */
2551
+ writeFileText64s(handle: string, offset64: string, charset: string, textData: string): void
2552
+
2553
+ /**
2554
+ * Asynchronous form of {@link SFtp.writeFileText64s}: the same call on a native worker thread,
2555
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2556
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2557
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2558
+ *
2559
+ * The promise rejects with an Error if the call fails; the full log is in
2560
+ * {@link SFtp.lastErrorText}.
2561
+ */
2562
+ writeFileText64sAsync(handle: string, offset64: string, charset: string, textData: string): Promise<void>
2563
+
2564
+ /**
2565
+ * Encodes the text in `sb` using `charset` and uploads it to `remoteFilePath`.
2566
+ *
2567
+ * Set `includeBom` to `true` to prepend a byte-order mark when the selected encoding supports
2568
+ * one.
2569
+ *
2570
+ * If the destination exists, it is truncated before the text is uploaded. For `utf-8`, setting
2571
+ * `includeBom` to `true` prepends the three bytes `EF BB BF`; setting it to `false` omits them.
2572
+ *
2573
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2574
+ * {@link SFtp.uploadSbAsync}.
2575
+ *
2576
+ * @throws Error if the call fails (the message names the reason); the full log is in
2577
+ * {@link SFtp.lastErrorText}.
2578
+ */
2579
+ uploadSb(sb: StringBuilder, remoteFilePath: string, charset: string, includeBom: boolean): void
2580
+
2581
+ /**
2582
+ * Asynchronous form of {@link SFtp.uploadSb}: the same call on a native worker thread,
2583
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2584
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2585
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2586
+ *
2587
+ * The promise rejects with an Error if the call fails; the full log is in
2588
+ * {@link SFtp.lastErrorText}.
2589
+ */
2590
+ uploadSbAsync(sb: StringBuilder, remoteFilePath: string, charset: string, includeBom: boolean): Promise<void>
2591
+
2592
+ /**
2593
+ * Uploads all bytes in `binData` to the remote file at `remoteFilePath`.
2594
+ *
2595
+ * If the destination exists, it is truncated before the bytes are uploaded.
2596
+ *
2597
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2598
+ * {@link SFtp.uploadBdAsync}.
2599
+ *
2600
+ * @throws Error if the call fails (the message names the reason); the full log is in
2601
+ * {@link SFtp.lastErrorText}.
2602
+ */
2603
+ uploadBd(binData: BinData, remoteFilePath: string): void
2604
+
2605
+ /**
2606
+ * Asynchronous form of {@link SFtp.uploadBd}: the same call on a native worker thread,
2607
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2608
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2609
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2610
+ *
2611
+ * The promise rejects with an Error if the call fails; the full log is in
2612
+ * {@link SFtp.lastErrorText}.
2613
+ */
2614
+ uploadBdAsync(binData: BinData, remoteFilePath: string): Promise<void>
2615
+
2616
+ /**
2617
+ * Downloads the remote file at `remoteFilePath` and appends its bytes to `binData`.
2618
+ *
2619
+ * Existing data in `binData` is preserved. Clear it first when replacement rather than append
2620
+ * behavior is required.
2621
+ *
2622
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2623
+ * {@link SFtp.downloadBdAsync}.
2624
+ *
2625
+ * @throws Error if the call fails (the message names the reason); the full log is in
2626
+ * {@link SFtp.lastErrorText}.
2627
+ */
2628
+ downloadBd(remoteFilePath: string, binData: BinData): void
2629
+
2630
+ /**
2631
+ * Asynchronous form of {@link SFtp.downloadBd}: the same call on a native worker thread,
2632
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2633
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2634
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2635
+ *
2636
+ * The promise rejects with an Error if the call fails; the full log is in
2637
+ * {@link SFtp.lastErrorText}.
2638
+ */
2639
+ downloadBdAsync(remoteFilePath: string, binData: BinData): Promise<void>
2640
+
2641
+ /**
2642
+ * Downloads the remote file at `remoteFilePath`, decodes it using `charset`, and appends the text
2643
+ * to `sb`.
2644
+ *
2645
+ * Existing text in `sb` is preserved. Clear it first when replacement rather than append behavior
2646
+ * is required.
2647
+ *
2648
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2649
+ * {@link SFtp.downloadSbAsync}.
2650
+ *
2651
+ * @throws Error if the call fails (the message names the reason); the full log is in
2652
+ * {@link SFtp.lastErrorText}.
2653
+ */
2654
+ downloadSb(remoteFilePath: string, charset: string, sb: StringBuilder): void
2655
+
2656
+ /**
2657
+ * Asynchronous form of {@link SFtp.downloadSb}: the same call on a native worker thread,
2658
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2659
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2660
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2661
+ *
2662
+ * The promise rejects with an Error if the call fails; the full log is in
2663
+ * {@link SFtp.lastErrorText}.
2664
+ */
2665
+ downloadSbAsync(remoteFilePath: string, charset: string, sb: StringBuilder): Promise<void>
2666
+
2667
+ /**
2668
+ * Sends an SSH `IGNORE` message. No SFTP file handle or channel is required.
2669
+ *
2670
+ * The server does not send a reply, but a successful send helps verify that the SSH connection is
2671
+ * still writable.
2672
+ *
2673
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2674
+ * {@link SFtp.sendIgnoreAsync}.
2675
+ *
2676
+ * @throws Error if the call fails (the message names the reason); the full log is in
2677
+ * {@link SFtp.lastErrorText}.
2678
+ */
2679
+ sendIgnore(): void
2680
+
2681
+ /**
2682
+ * Asynchronous form of {@link SFtp.sendIgnore}: the same call on a native worker thread,
2683
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2684
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2685
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2686
+ *
2687
+ * The promise rejects with an Error if the call fails; the full log is in
2688
+ * {@link SFtp.lastErrorText}.
2689
+ */
2690
+ sendIgnoreAsync(): Promise<void>
2691
+
2692
+ /**
2693
+ * Checks the remote item at `remotePath`. When `followLinks` is `true`, a symbolic link is
2694
+ * followed and the target type is returned.
2695
+ *
2696
+ * Return valueMeaning
2697
+ *
2698
+ * | `-1` | | Unable to determine the result. Inspect `LastErrorText`. |
2699
+ *
2700
+ * | `0` | | The path does not exist. |
2701
+ *
2702
+ * | `1` | | A regular file exists. |
2703
+ *
2704
+ * | `2` | | A directory exists. |
2705
+ *
2706
+ * | `3` | | A symbolic link exists. This is possible only when `followLinks` is `false`. |
2707
+ *
2708
+ * | `4` | | A special filesystem entry exists. |
2709
+ *
2710
+ * | `5` | | An entry of unknown type exists. |
2711
+ *
2712
+ * | `6` | | A socket exists. |
2713
+ *
2714
+ * | `7` | | A character device exists. |
2715
+ *
2716
+ * | `8` | | A block device exists. |
2717
+ *
2718
+ * | `9` | | A FIFO exists. |
2719
+ *
2720
+ * Positive values correspond to SFTP filesystem entry types. Some types are platform-dependent.
2721
+ *
2722
+ * For a dangling symbolic link, `followLinks = _FALSE_` returns `3` for the link itself, while
2723
+ * `followLinks = _TRUE_` returns `0` because the target does not exist.
2724
+ *
2725
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2726
+ * {@link SFtp.fileExistsAsync}.
2727
+ */
2728
+ fileExists(remotePath: string, followLinks: boolean): number
2729
+
2730
+ /**
2731
+ * Asynchronous form of {@link SFtp.fileExists}: the same call on a native worker thread,
2732
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2733
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2734
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2735
+ */
2736
+ fileExistsAsync(remotePath: string, followLinks: boolean): Promise<number>
2737
+
2738
+ /**
2739
+ * Works like {@link SFtp.authenticatePw}, but receives `login` and `password` in `SecureString`
2740
+ * objects.
2741
+ *
2742
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2743
+ * {@link SFtp.authenticateSecPwAsync}.
2744
+ *
2745
+ * @throws Error if the call fails (the message names the reason); the full log is in
2746
+ * {@link SFtp.lastErrorText}.
2747
+ */
2748
+ authenticateSecPw(login: SecureString, password: SecureString): void
2749
+
2750
+ /**
2751
+ * Asynchronous form of {@link SFtp.authenticateSecPw}: the same call on a native worker thread,
2752
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2753
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2754
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2755
+ *
2756
+ * The promise rejects with an Error if the call fails; the full log is in
2757
+ * {@link SFtp.lastErrorText}.
2758
+ */
2759
+ authenticateSecPwAsync(login: SecureString, password: SecureString): Promise<void>
2760
+
2761
+ /**
2762
+ * Works like {@link SFtp.authenticatePwPk}, but receives `username` and `password` in
2763
+ * `SecureString` objects. `privateKey` supplies the private key.
2764
+ *
2765
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2766
+ * {@link SFtp.authenticateSecPwPkAsync}.
2767
+ *
2768
+ * @throws Error if the call fails (the message names the reason); the full log is in
2769
+ * {@link SFtp.lastErrorText}.
2770
+ */
2771
+ authenticateSecPwPk(username: SecureString, password: SecureString, privateKey: SshKey): void
2772
+
2773
+ /**
2774
+ * Asynchronous form of {@link SFtp.authenticateSecPwPk}: the same call on a native worker thread,
2775
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2776
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2777
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2778
+ *
2779
+ * The promise rejects with an Error if the call fails; the full log is in
2780
+ * {@link SFtp.lastErrorText}.
2781
+ */
2782
+ authenticateSecPwPkAsync(username: SecureString, password: SecureString, privateKey: SshKey): Promise<void>
2783
+
2784
+ /**
2785
+ * Creates a symbolic link on the server. `oldPath` identifies the link target and `newPath`
2786
+ * identifies the new symbolic-link path.
2787
+ *
2788
+ * The server's SFTP implementation determines path interpretation and whether symbolic links are
2789
+ * permitted.
2790
+ *
2791
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2792
+ * {@link SFtp.symLinkAsync}.
2793
+ *
2794
+ * @throws Error if the call fails (the message names the reason); the full log is in
2795
+ * {@link SFtp.lastErrorText}.
2796
+ */
2797
+ symLink(oldPath: string, newPath: string): void
2798
+
2799
+ /**
2800
+ * Asynchronous form of {@link SFtp.symLink}: the same call on a native worker thread,
2801
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2802
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2803
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2804
+ *
2805
+ * The promise rejects with an Error if the call fails; the full log is in
2806
+ * {@link SFtp.lastErrorText}.
2807
+ */
2808
+ symLinkAsync(oldPath: string, newPath: string): Promise<void>
2809
+
2810
+ /**
2811
+ * Creates a hard link from `newPath` to the existing remote file at `oldPath`.
2812
+ *
2813
+ * This method uses the OpenSSH `hardlink@openssh.com` extension and succeeds only when the server
2814
+ * supports that extension.
2815
+ *
2816
+ * A successful hard link refers to the same underlying file. Modifying the existing file through
2817
+ * either path changes the content observed through the other path.
2818
+ *
2819
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2820
+ * {@link SFtp.hardLinkAsync}.
2821
+ *
2822
+ * @throws Error if the call fails (the message names the reason); the full log is in
2823
+ * {@link SFtp.lastErrorText}.
2824
+ */
2825
+ hardLink(oldPath: string, newPath: string): void
2826
+
2827
+ /**
2828
+ * Asynchronous form of {@link SFtp.hardLink}: the same call on a native worker thread,
2829
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2830
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2831
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2832
+ *
2833
+ * The promise rejects with an Error if the call fails; the full log is in
2834
+ * {@link SFtp.lastErrorText}.
2835
+ */
2836
+ hardLinkAsync(oldPath: string, newPath: string): Promise<void>
2837
+
2838
+ /**
2839
+ * Requests that the server flush pending data for the open file identified by `handle` to stable
2840
+ * storage.
2841
+ *
2842
+ * This method uses the OpenSSH `fsync@openssh.com` extension and succeeds only when the server
2843
+ * supports that extension.
2844
+ *
2845
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2846
+ * {@link SFtp.fsyncAsync}.
2847
+ *
2848
+ * @throws Error if the call fails (the message names the reason); the full log is in
2849
+ * {@link SFtp.lastErrorText}.
2850
+ */
2851
+ fsync(handle: string): void
2852
+
2853
+ /**
2854
+ * Asynchronous form of {@link SFtp.fsync}: the same call on a native worker thread,
2855
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2856
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2857
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2858
+ *
2859
+ * The promise rejects with an Error if the call fails; the full log is in
2860
+ * {@link SFtp.lastErrorText}.
2861
+ */
2862
+ fsyncAsync(handle: string): Promise<void>
2863
+
2864
+ /**
2865
+ * Returns the target path stored in the symbolic link at remote `path`.
2866
+ *
2867
+ * The returned value is the target string stored in the link. It is not automatically
2868
+ * canonicalized and can be relative, absolute, or refer to a nonexistent target.
2869
+ *
2870
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2871
+ * {@link SFtp.readLinkAsync}.
2872
+ *
2873
+ * @throws Error if the call fails (the message names the reason); the full log is in
2874
+ * {@link SFtp.lastErrorText}.
2875
+ */
2876
+ readLink(path: string): string
2877
+
2878
+ /**
2879
+ * Asynchronous form of {@link SFtp.readLink}: the same call on a native worker thread,
2880
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2881
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2882
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2883
+ *
2884
+ * The promise rejects with an Error if the call fails; the full log is in
2885
+ * {@link SFtp.lastErrorText}.
2886
+ */
2887
+ readLinkAsync(path: string): Promise<string>
2888
+
2889
+ /**
2890
+ * Appends all bytes in `bd` to the remote file identified by `handle`. The handle must have been
2891
+ * returned by {@link SFtp.openFile}.
2892
+ *
2893
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2894
+ * {@link SFtp.writeFileBdAsync}.
2895
+ *
2896
+ * @throws Error if the call fails (the message names the reason); the full log is in
2897
+ * {@link SFtp.lastErrorText}.
2898
+ */
2899
+ writeFileBd(handle: string, bd: BinData): void
2900
+
2901
+ /**
2902
+ * Asynchronous form of {@link SFtp.writeFileBd}: the same call on a native worker thread,
2903
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2904
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2905
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2906
+ *
2907
+ * The promise rejects with an Error if the call fails; the full log is in
2908
+ * {@link SFtp.lastErrorText}.
2909
+ */
2910
+ writeFileBdAsync(handle: string, bd: BinData): Promise<void>
2911
+
2912
+ /**
2913
+ * Reads up to `numBytes` bytes from the current position of the remote file identified by
2914
+ * `handle` and appends them to `bd`. The handle must have been returned by {@link SFtp.openFile}.
2915
+ *
2916
+ * Fewer bytes can be read when end-of-file is reached. Repeat the call until `Eof(handle)`
2917
+ * returns `true` to read the entire file incrementally.
2918
+ *
2919
+ * This method shares the handle's sequential read position with `ReadFileBytes` and {@link
2920
+ * SFtp.readFileText}. Existing bytes in `bd` are preserved.
2921
+ *
2922
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2923
+ * {@link SFtp.readFileBdAsync}.
2924
+ *
2925
+ * @throws Error if the call fails (the message names the reason); the full log is in
2926
+ * {@link SFtp.lastErrorText}.
2927
+ */
2928
+ readFileBd(handle: string, numBytes: number, bd: BinData): void
2929
+
2930
+ /**
2931
+ * Asynchronous form of {@link SFtp.readFileBd}: the same call on a native worker thread,
2932
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2933
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2934
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2935
+ *
2936
+ * The promise rejects with an Error if the call fails; the full log is in
2937
+ * {@link SFtp.lastErrorText}.
2938
+ */
2939
+ readFileBdAsync(handle: string, numBytes: number, bd: BinData): Promise<void>
2940
+
2941
+ /**
2942
+ * Begins keyboard-interactive authentication for `login` and returns XML describing the server's
2943
+ * prompts.
2944
+ *
2945
+ * ```
2946
+ * <infoRequest numPrompts="N">
2947
+ * <name>name_string</name>
2948
+ * <instruction>instruction_string</instruction>
2949
+ * <prompt1 echo="1_or_0">prompt_string</prompt1>
2950
+ * ...
2951
+ * <promptN echo="1_or_0">prompt_string</promptN>
2952
+ * </infoRequest>
2953
+ * ```
2954
+ *
2955
+ * The `echo` attribute indicates whether the response may be displayed while entered. A value of
2956
+ * `0` normally identifies secret input such as a password.
2957
+ *
2958
+ * If authentication immediately succeeds or fails, the result has one of these forms:
2959
+ *
2960
+ * ```
2961
+ * <success>success message</success>
2962
+ *
2963
+ * <error>error message</error>
2964
+ * ```
2965
+ *
2966
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2967
+ * {@link SFtp.startKeyboardAuthAsync}.
2968
+ *
2969
+ * @throws Error if the call fails (the message names the reason); the full log is in
2970
+ * {@link SFtp.lastErrorText}.
2971
+ */
2972
+ startKeyboardAuth(login: string): string
2973
+
2974
+ /**
2975
+ * Asynchronous form of {@link SFtp.startKeyboardAuth}: the same call on a native worker thread,
2976
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2977
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
2978
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
2979
+ *
2980
+ * The promise rejects with an Error if the call fails; the full log is in
2981
+ * {@link SFtp.lastErrorText}.
2982
+ */
2983
+ startKeyboardAuthAsync(login: string): Promise<string>
2984
+
2985
+ /**
2986
+ * Continues keyboard-interactive authentication by submitting `response` for the prompts returned
2987
+ * by {@link SFtp.startKeyboardAuth}.
2988
+ *
2989
+ * For a single prompt, pass the response text directly. For multiple prompts, pass XML in this
2990
+ * form:
2991
+ *
2992
+ * ```
2993
+ * <response>
2994
+ * <response1>response to first prompt</response1>
2995
+ * <response2>response to second prompt</response2>
2996
+ * ...
2997
+ * </response>
2998
+ * ```
2999
+ *
3000
+ * The returned XML indicates authentication success, authentication failure, or another
3001
+ * `infoRequest` containing additional prompts.
3002
+ *
3003
+ * ```
3004
+ * <success>success message</success>
3005
+ *
3006
+ * <error>error message</error>
3007
+ * ```
3008
+ *
3009
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3010
+ * {@link SFtp.continueKeyboardAuthAsync}.
3011
+ *
3012
+ * @throws Error if the call fails (the message names the reason); the full log is in
3013
+ * {@link SFtp.lastErrorText}.
3014
+ */
3015
+ continueKeyboardAuth(response: string): string
3016
+
3017
+ /**
3018
+ * Asynchronous form of {@link SFtp.continueKeyboardAuth}: the same call on a native worker
3019
+ * thread,
3020
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3021
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
3022
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
3023
+ *
3024
+ * The promise rejects with an Error if the call fails; the full log is in
3025
+ * {@link SFtp.lastErrorText}.
3026
+ */
3027
+ continueKeyboardAuthAsync(response: string): Promise<string>
3028
+
3029
+ /**
3030
+ * Returns the connected server's host-key fingerprint using `hashAlg`. Common choices include
3031
+ * `SHA256`, `SHA384`, `SHA512`, `SHA1`, and `MD5`.
3032
+ *
3033
+ * includeKeyTypeincludeHashNameExample format
3034
+ *
3035
+ * | `true` | | `true` | | `ssh-rsa SHA256:L7sQgnpnoBwRoyIYXAFBs8SdSnwtyYmhXs1p/mQDK...` |
3036
+ *
3037
+ * | `true` | | `false` | | `ssh-rsa L7sQgnpnoBwRoyIYXAFBs8SdSnwtyYmhXs1p/mQDK...` |
3038
+ *
3039
+ * | `false` | | `true` | | `SHA256:L7sQgnpnoBwRoyIYXAFBs8SdSnwtyYmhXs1p/mQDK...` |
3040
+ *
3041
+ * | `false` | | `false` | | `L7sQgnpnoBwRoyIYXAFBs8SdSnwtyYmhXs1p/mQDK...` |
3042
+ *
3043
+ * For server identity verification, compare a SHA-256 fingerprint with a value obtained from a
3044
+ * trusted source before sending credentials.
3045
+ *
3046
+ * @throws Error if the call fails (the message names the reason); the full log is in
3047
+ * {@link SFtp.lastErrorText}.
3048
+ */
3049
+ getHostKeyFP(hashAlg: string, includeKeyType: boolean, includeHashName: boolean): string
3050
+
3051
+ /**
3052
+ * Configures the exact set of SSH algorithms permitted for subsequent connections using the
3053
+ * settings in `json`.
3054
+ *
3055
+ * Call this method before `Connect`. The connection fails when no mutually supported algorithm
3056
+ * remains in a required category.
3057
+ *
3058
+ * @throws Error if the call fails (the message names the reason); the full log is in
3059
+ * {@link SFtp.lastErrorText}.
3060
+ */
3061
+ setAllowedAlgorithms(json: JsonObject): void
3062
+
3063
+ /**
3064
+ * Appends to `strTab` the relative paths processed by the most recent {@link SFtp.syncTreeUpload}
3065
+ * or {@link SFtp.syncTreeDownload} operation.
3066
+ *
3067
+ * For downloads, entries can include local directories that were created. Directory paths end
3068
+ * with `/` so they can be distinguished from file paths.
3069
+ *
3070
+ * Existing entries in `strTab` are preserved.
3071
+ *
3072
+ * Clear `strTab` first when only the latest synchronization results are wanted. Downloaded
3073
+ * directory entries are reported with a trailing `/`; uploaded directory entries are reported
3074
+ * without one.
3075
+ */
3076
+ getSyncedFiles(strTab: StringTable): void
3077
+
3078
+ /**
3079
+ * Populates `json` with supplemental details produced by the most recent method when such details
3080
+ * are available. Many methods do not produce additional JSON information.
3081
+ */
3082
+ getLastJsonData(json: JsonObject): void
3083
+
3084
+ /**
3085
+ * Reads all remaining directory entries from `handle`, which must have been returned by {@link
3086
+ * SFtp.openDir}, and stores them in `dirObj`. Entries are returned in server order; Chilkat does
3087
+ * not sort the listing.
3088
+ *
3089
+ * After end-of-directory has been reached, another call on the same handle returns `true`, adds
3090
+ * no entries, and sets {@link SFtp.lastStatusCode} to `SSH_FX_EOF`.
3091
+ *
3092
+ * This method does not clear `dirObj`. Use a new or cleared `SFtpDir` object when an empty result
3093
+ * must replace an earlier listing. Close the directory handle when finished.
3094
+ *
3095
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3096
+ * {@link SFtp.readDirListingAsync}.
3097
+ *
3098
+ * @throws Error if the call fails (the message names the reason); the full log is in
3099
+ * {@link SFtp.lastErrorText}.
3100
+ */
3101
+ readDirListing(handle: string, dirObj: SFtpDir): void
3102
+
3103
+ /**
3104
+ * Asynchronous form of {@link SFtp.readDirListing}: the same call on a native worker thread,
3105
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3106
+ * except {@link SFtp.abort} (which cancels it) and the {@link SFtp.onPercentDone} /
3107
+ * {@link SFtp.onProgressInfo} callbacks, which report progress while it runs.
3108
+ *
3109
+ * The promise rejects with an Error if the call fails; the full log is in
3110
+ * {@link SFtp.lastErrorText}.
3111
+ */
3112
+ readDirListingAsync(handle: string, dirObj: SFtpDir): Promise<void>
3113
+
3114
+ // ---- Events (ReactNativeGen_DESIGN.md §6) ----
3115
+
3116
+ /**
3117
+ * Called with the percent completed (0..100) while a long-running method runs, when Chilkat
3118
+ * can measure progress. Runs on the JavaScript thread, so it is only useful with the
3119
+ * `...Async` methods (during a synchronous call the thread is busy and the events arrive
3120
+ * after it returns). Assign `undefined` to remove.
3121
+ */
3122
+ onPercentDone?: (pctDone: number) => void
3123
+
3124
+ /**
3125
+ * Called with a name/value pair of progress information while a long-running method runs
3126
+ * (what is reported depends on the class and method). Runs on the JavaScript thread; see
3127
+ * {@link SFtp.onPercentDone}. Assign `undefined` to remove.
3128
+ */
3129
+ onProgressInfo?: (name: string, value: string) => void
3130
+
3131
+ /**
3132
+ * Requests that the pending `...Async` call on this object stop at its next progress check.
3133
+ * The promise then rejects with Chilkat's abort error. Chilkat checks at least every
3134
+ * `heartbeatMs` milliseconds on the classes that have that property, so set it (e.g. 250)
3135
+ * for a responsive cancel. Harmless when nothing is pending.
3136
+ */
3137
+ abort(): void
3138
+ }